Rippling: Retrieve record details — response body — fields value data type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED

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

Field	Type	Presence	Description and constraints
$	object	Root	A readable record field and the caller’s ability to edit it.
api_name	string	Required within parent	Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only.
data_type	string	Required within parent	OG_REFERENCE_FIELD identifies a reference to the collection in reference_object, including standard owner and audit Worker references. Known values: OG_REFERENCE_FIELD
editable	boolean	Required within parent	Whether this caller can edit this field on this record.
label	string	Required within parent	Field display name.
multiple	boolean	Required within parent	Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.
options	array	Required within parent	Configured choice values; empty for non-choice fields.
options[]	string	Each item
read_only_reason	JSON	Optional
read_only_reason (anyOf 1)	string	Alternative	PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable. Known values: PERMISSION_DENIED, RECORD_LOCKED, IMMUTABLE, MANAGED_OR_DERIVED, UNSUPPORTED_EDITOR, MASKED, REFERENCE_UNAVAILABLE
read_only_reason (anyOf 2)	null	Alternative
reference_object	JSON	Optional
reference_object (anyOf 1)	string	Alternative	Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets.
reference_object (anyOf 2)	null	Alternative
required	boolean	Required within parent	Whether a nonempty value is required by the field schema.
value	JSON	Required within parent	Canonical relationship pair for reference_object: worker_id and expandable worker, or custom_object_record_id and expandable custom_object_record. Null unless PRESENT; masked references disclose no identifier or resource.
value (anyOf 1)	Model	Alternative	Expand Retrieve record details — response body — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value worker, worker id
value (anyOf 2)	Model	Alternative	Expand 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
value (anyOf 3)	JSON	Alternative
value (anyOf 3) (anyOf 1)	string	Alternative
value (anyOf 3) (anyOf 2)	null	Alternative
value_state	string	Required within parent	PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array. Known values: PRESENT, EMPTY, MASKED, UNSUPPORTED

Referenced models: 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 — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value worker, worker id