Rippling: Retrieve record details — response body — layout tabs item sections item
Retrieve record details: response body, field layout / tabs / item / sections / item. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: Retrieve record details — response body — layout tabs item sections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Visible group of field placements, a deferred related list, or explicitly unsupported content. |
columns | JSON | Required within parent | |
columns (anyOf 1) | integer | Alternative | Suggested field columns; clients may adapt to available space. |
columns (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fields | array | Required within parent | Ordered placements for a FIELDS section. Empty for RELATED_LIST and UNSUPPORTED sections. |
fields[] | Model | Each item | Expand Retrieve record details — response body — layout tabs item sections item fields item |
id | string | Required within parent | Section identifier scoped to the effective layout. Use a RELATED_LIST section’s records_link to retrieve its records. |
label | string | Required within parent | Section display name. |
object_api_name | JSON | Optional | |
object_api_name (anyOf 1) | string | Alternative | Related Custom Object API name; null for other sections. |
object_api_name (anyOf 2) | null | Alternative | |
reason | JSON | Optional | |
reason (anyOf 1) | string | Alternative | CONTENT_NOT_SUPPORTED means this section requires a renderer outside this API; RELATED_OBJECT_NOT_SUPPORTED means the related list targets a native object, which this release cannot render. Null for supported field and Custom Object related-list sections. Known values: CONTENT_NOT_SUPPORTED, RELATED_OBJECT_NOT_SUPPORTED |
reason (anyOf 2) | null | Alternative | |
records_link | JSON | Optional | |
records_link (anyOf 1) | string | Alternative | Authorized related-record collection URL, including the resolved layout; null for other sections. |
records_link (anyOf 2) | null | Alternative | |
type | string | Required within parent | FIELDS contains ordered field placements; RELATED_LIST describes records loaded through records_link; UNSUPPORTED identifies visible content this API cannot render. Known values: FIELDS, RELATED_LIST, UNSUPPORTED |
Referenced models: Retrieve record details — response body — layout tabs item sections item fields item