Describe Layouts

Returns a list of layouts and descriptions. The list of fields and the layout name are returned.

URI

To return descriptions of global publisher layouts, the URI is: /vXX.X/sobjects/Global/describe/layouts/

For a layout description for a specific object, use /vXX.X/sobjects/Object/describe/layouts/

For a layout description for objects that have more than one record type defined, use /vXX.X/sobjects/Object/describe/layouts/<recordTypeId>. For example, the following URI requests the layout for a specific Contact record ID: /vXX.X/sobjects/Contact/describe/layouts/012xx00000024x5AAA. A GET request for objects that have more than one record type defined returns null for the layouts section of the response.

Formats

JSON, XML

HTTP Method

HEAD, GET

Authentication

Authorization: Bearer token

Parameters

None required

Example for getting global publisher layouts

Example JSON Response body contactlayout.json file