---
schema_version: "1"
id: 4496c26f40b6d7b0ad6ae4c6359e90896ffc5f04c4f9ccd5fa6ef9a70f5dfff5
title: Record Layout
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_layout.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 4dc1fcae0c013aa022edaaa70f4716effa94036db13071b8727b87055d2f6b0f
description: The layout information for a record.
---
# Record Layout

The layout information for a record.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d162701e33">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d162701e35">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d162701e37">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d162701e39">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d162701e41">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d162701e33" data-title="Property Name"><samp class="codeph nolang">id</samp></td>

              <td class="entry" headers="d162701e35" data-title="Type">String</td>

              <td class="entry" headers="d162701e37" data-title="Description">The layout ID.</td>

              <td class="entry" headers="d162701e39" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d162701e41" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d162701e33" data-title="Property Name"><samp class="codeph nolang">layoutType</samp></td>

              <td class="entry" headers="d162701e35" data-title="Type">String</td>

              <td class="entry" headers="d162701e37" data-title="Description">The layout type for the record. One of these values:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Compact</samp>—Use this value to get a layout
                    that contains a record’s key fields.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Full</samp>—(Default) Use this value to get a
                    full layout.
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d162701e39" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d162701e41" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d162701e33" data-title="Property Name"><samp class="codeph nolang">mode</samp></td>

              <td class="entry" headers="d162701e35" data-title="Type">String</td>

              <td class="entry" headers="d162701e37" data-title="Description">The access mode for the record. This value determines which fields to get from
                a layout. Layouts have different fields for create, edit, and view modes. For
                example, formula fields are rendered in view mode, but not in create mode because
                they’re calculated at run time, like formulas in a spreadsheet. One of these values:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Create</samp>—Use this mode if you intend to
                    build UI that lets a user create a record. This mode is used by the <samp class="codeph nolang">/ui-api/record-defaults/create/{apiName}</samp>
                    resource.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Edit</samp>—Use this mode if you intend to build
                    UI that lets a user edit a record. This mode is used by the <samp class="codeph nolang">/ui-api/record-defaults/clone/{recordId}</samp>
                    resource.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">View</samp>—(Default) Use this mode to build UI
                    that displays a record.
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d162701e39" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d162701e41" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d162701e33" data-title="Property Name"><samp class="codeph nolang">objectApiName</samp></td>

              <td class="entry" headers="d162701e35" data-title="Type">String</td>

              <td class="entry" headers="d162701e37" data-title="Description">The API name of the object that the layout is associated with.</td>

              <td class="entry" headers="d162701e39" data-title="Filter Group and Version">Small, 49.0</td>

              <td class="entry" headers="d162701e41" data-title="Available Version">49.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d162701e33" data-title="Property Name"><samp class="codeph nolang">recordTypeId</samp></td>

              <td class="entry" headers="d162701e35" data-title="Type">String</td>

              <td class="entry" headers="d162701e37" data-title="Description">The record type ID for this record.</td>

              <td class="entry" headers="d162701e39" data-title="Filter Group and Version">Small, 49.0</td>

              <td class="entry" headers="d162701e41" data-title="Available Version">49.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d162701e33" data-title="Property Name"><samp class="codeph nolang">saveOptions</samp></td>

              <td class="entry" headers="d162701e35" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_save_option.htm" title="The save option for a record layout. Save options define behavior that occurs when objects are created or modified using the given layout. For example, for Cases and Leads, a “UseDefaultAssignmentRule” save option is exposed to control whether assignment rules are applied when Cases or Leads are created or edited.">Record Layout Save Option</a>[]
              </td>

              <td class="entry" headers="d162701e37" data-title="Description">The save options for the layout.</td>

              <td class="entry" headers="d162701e39" data-title="Filter Group and Version">Small, 51.0</td>

              <td class="entry" headers="d162701e41" data-title="Available Version">51.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d162701e33" data-title="Property Name"><samp class="codeph nolang">sections</samp></td>

              <td class="entry" headers="d162701e35" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_section.htm#ui_api_responses_record_layout_section" title="A section in a record layout.">Record Layout Section</a>[]
              </td>

              <td class="entry" headers="d162701e37" data-title="Description">A collection of layout sections.</td>

              <td class="entry" headers="d162701e39" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d162701e41" data-title="Available Version">41.0</td>

            </tr>

          </tbody>
        </table>

#### See Also

- [Record UI](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_ui.htm "The layout information, field information, and data for a record.")
- [Record Defaults](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_defaults.htm "The default information and data needed to create or clone a record. Use these values in a request to POST /ui-api/records.")
- [Quick Action Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_quick_action_layout.htm "The record layout used by the quick action.")
- [Get Record Layout Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_layout.htm "Get metadata about page layouts for the specified object type.")
- [Get Default Values to Clone a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_clone.htm "Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.")
- [Get Default Values to Create a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_create.htm "Get the default values for fields for a new record of a specified object and optional record type. After getting the default values, make a request to POST /ui-api/records to create the record.")