---
schema_version: "1"
id: 8a1ccc4bbadaffda1ac6a93a2cb011458a3cb2ffa064fb8e2fdac6c5718c9bf8
title: Get Record Layout Metadata
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/uiapi/ui_api_resources_record_layout.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_layout.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: a36b9d4f806c0d3c18ba3f3f9382802861a19ee9ccc224b0a97d7d4fd292242f
description: Get metadata about page layouts for the specified object type.
---
# Get Record Layout Metadata

Get metadata about page layouts for the specified object type.

Resource

/ui-api/layout/{objectApiName}

objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object.

Available Version

41.0

HTTP Method

GET

Request Parameters

<table class="featureTable sort_table" summary="">





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d72763e103">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d72763e106">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d72763e109">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d72763e112">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d72763e115">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d72763e103" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

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

                  <td class="entry" headers="d72763e109" data-title="Description">The layout display size for the record. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d72763e112" data-title="Required or Optional">Optional</td>

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

                </tr>

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

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

                  <td class="entry" headers="d72763e109" 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="d72763e112" data-title="Required or Optional">Optional</td>

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

                </tr>

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

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

                  <td class="entry" headers="d72763e109" 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="d72763e112" data-title="Required or Optional">Optional</td>

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

                </tr>

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

                  <td class="entry" headers="d72763e106" data-title="Type">Id</td>

                  <td class="entry" headers="d72763e109" data-title="Description">The ID of the record type (RecordType object) for the new record. If not
                    provided, the default record type is used.</td>

                  <td class="entry" headers="d72763e112" data-title="Required or Optional">Optional</td>

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

                </tr>

              </tbody>

            </table>

Response Body

[Record Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout.htm#ui_api_responses_record_layout "The layout information for a record.")

#### See Also

- [User Interface API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_quick_start_postman.htm "Use the Postman desktop app or web-based UI to easily explore and test the UI API and other Salesforce APIs against your orgs.")