Rippling: Retrieve record details — response body — fields value data type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value worker, worker id
Retrieve record details: response body, field fields / value / data_type: OG_REFERENCE_FIELD, value_state: PRESENT, EMPTY, MASKED, UNSUPPORTED / value / worker, worker_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 worker, worker id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A canonical Worker relationship; Worker facts belong to its expansion. |
worker | JSON | Optional | Exact canonical Worker response, included with expand=fields.value.worker or fields.value.worker.user. Null when not expanded or unavailable under target permissions. |
worker (anyOf 1) | Model | Alternative | Expand Retrieve a specific worker — response body — manager |
worker (anyOf 2) | JSON | Alternative | |
worker (anyOf 2) (anyOf 1) | string | Alternative | |
worker (anyOf 2) (anyOf 2) | null | Alternative | |
worker_id | string | Required within parent | Canonical Worker identifier accepted by the Custom Object record PATCH endpoint. Retrieve it through GET /workers/{worker_id}/. |
Referenced models: Retrieve a specific worker — response body — manager