Get Record Layout Metadata

Get metadata about page layouts for the specified object type.

Resource

1/ui-api/layout/{objectApiName}

objectApiName—A supported object.

Available Version

41.0

HTTP Method

GET

Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`formFactor`	String	The layout display size for the record. One of these values: `Large`—(Default) Use this value to get a layout for desktop display size. `Medium`—Use this value to get a layout for tablet display size. `Small`—Use this value to get a layout for phone display size.	Optional	41.0
`layoutType`	String	The layout type for the record. One of these values: `Compact`—Use this value to get a layout that contains a record’s key fields. `Full`—(Default) Use this value to get a full layout.	Optional	41.0
`mode`	String	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: `Create`—Use this mode if you intend to build UI that lets a user create a record. This mode is used by the `/ui-api/record-defaults/create/{apiName}` resource. `Edit`—Use this mode if you intend to build UI that lets a user edit a record. This mode is used by the `/ui-api/record-defaults/clone/{recordId}` resource. `View`—(Default) Use this mode if you intend to build UI that displays a record.	Optional	41.0
`recordTypeId`	Id	The ID of the record type (RecordType object) for the new record. If not provided, the default record type is used.	Optional	41.0

Response Body

Record Layout

User Interface API Developer Guide