API reference · Contract 2026-10-28
SDK schema: Retrieve record details — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Record values, edit capabilities, and the effective page layout for one readable Custom Object record. |
capabilities | Model | Required within parent | Expand Retrieve record details — response body — capabilities |
fields | object | Required within parent | Permission-visible direct fields plus read-only related fields used by the layout.
Additional keys: see wildcard field |
fields.* | JSON | Additional keys | |
fields.* (anyOf 1) | Model | Alternative | Expand Retrieve record details — response body — fields / value / data_type: TEXT, LONG TEXT, EMAIL, URL, PHONE NUMBER, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED |
fields.* (anyOf 2) | Model | Alternative | Expand Retrieve record details — response body — fields / value / data_type: NUMBER, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED |
fields.* (anyOf 3) | Model | Alternative | Expand Retrieve record details — response body — fields / value / data_type: BOOLEAN, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED |
fields.* (anyOf 4) | Model | Alternative | Expand Retrieve record details — response body — fields / value / data_type: DATE, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED |
fields.* (anyOf 5) | Model | Alternative | Expand Retrieve record details — response body — fields / value / data_type: DATETIME, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED |
fields.* (anyOf 6) | Model | Alternative | Expand Retrieve record details — response body — fields / value / data_type: CURRENCY, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED |
fields.* (anyOf 7) | Model | Alternative | Expand Retrieve record details — response body — fields / value / data_type: RADIO, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED |
fields.* (anyOf 8) | Model | Alternative | Expand Retrieve record details — response body — fields / value / data_type: SELECT, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED |
fields.* (anyOf 9) | Model | Alternative | Expand Retrieve record details — response body — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED |
fields.* (anyOf 10) | Model | Alternative | Expand Retrieve record details — response body — fields / value / value_state: PRESENT, EMPTY, MASKED, UNSUPPORTED |
id | string | Required within parent | Stable record identifier returned by the canonical Custom Object record list or query endpoint. Use it with object_api_name for canonical record GET and PATCH. |
layout | Model | Required within parent | Expand Retrieve record details — response body — layout |
object_api_name | string | Required within parent | Custom Object API name, such as equipment__c, used to address this record’s collection. Obtain it from the Custom Object definition or grid configuration. |
updated_at | string | Required within parent | ISO 8601 UTC timestamp of the loaded record version. Pass this exact value as lock_update_time in the canonical record PATCH to detect stale writes.
Format: date-time |
Referenced models: Retrieve record details — response body — fields / value / data_type: BOOLEAN, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: RADIO, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: CURRENCY, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: DATE, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: DATETIME, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — layout, Retrieve record details — response body — fields / value / data_type: SELECT, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: NUMBER, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: TEXT, LONG TEXT, EMAIL, URL, PHONE NUMBER, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / value_state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — capabilities
