Rippling: Retrieve record details — response body — fields value data type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value custom object record, custom object record id
Retrieve record details: response body, field fields / value / data_type: OG_REFERENCE_FIELD, value_state: PRESENT, EMPTY, MASKED, UNSUPPORTED / value / custom_object_record, custom_object_record_id. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: Retrieve record details — response body — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value custom object record, custom object record id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A canonical Custom Object record relationship, including its dynamic fields. |
custom_object_record | JSON | Optional | Exact canonical Custom Object record response, including readable dynamic fields; included with expand=fields.value.custom_object_record. Null when not expanded or unavailable under target permissions. |
custom_object_record (anyOf 1) | Model | Alternative | Expand Retrieve a specific custom object record — response body |
custom_object_record (anyOf 2) | JSON | Alternative | |
custom_object_record (anyOf 2) (anyOf 1) | string | Alternative | |
custom_object_record (anyOf 2) (anyOf 2) | null | Alternative | |
custom_object_record_id | string | Required within parent | Canonical record identifier in reference_object. Retrieve it through GET /custom-objects/{reference_object}/records/{custom_object_record_id}/; PATCH accepts this identifier. |
Referenced models: Retrieve a specific custom object record — response body