Object Info, Get

Get metadata (field list and object properties) about a specific object.

Resource

1/ui-api/object-info/{objectApiName}

Available version

39.0

HTTP methods

GET

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`layoutTypes`	String[]	The layout type for the record. A collection containing any 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	39.0
`modes`	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. A collection containing any 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	39.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	39.0

Response body for GET

Object Info

User Interface API Developer Guide