Rippling: List worker changes — response body — results item
List worker changes: response body, field results / item. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: List worker changes — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applied_on | string | Required within parent | When the change was persisted (approval time for changes that went through an approval workflow). UTC. Monotonically increasing as new commits land; use as the cursor axis for incremental polling. |
changed_by | Model | Optional | Expand Retrieve a specific worker change — response body — changed by |
changed_by_id | string | Optional | Actor who made the change. Null for system-initiated events. |
changes | array | Required within parent | Field-level changes captured by this event. Per-field REDACTED entries appear for fields the caller cannot read so consumers can detect that a change occurred even when the value is hidden. Events where every changed field is invisible to the caller — either internal fields not exposed via the public Object Graph, or fields the caller’s role has zero read permission on — are dropped from the response entirely (they never appear with an all-REDACTED changes array). |
changes[] | Model | Each item | Expand Retrieve a specific worker change — response body — changes item |
created_at | string | Required within parent | Record creation date |
effective_on | string | Required within parent | When the change is true in the business domain. Can be past, present, or future. Independent of applied_on. UTC. |
event_type | string | Required within parent | The lifecycle event type this change represents. CHANGE is the catch-all for non-lifecycle field edits. Known values: HIRE, CHANGE, SCHEDULED_CHANGE, OFFBOARD, SCHEDULED_OFFBOARD, IMPORT, UNDO, EFFECTIVE_DATE_AMENDMENT |
id | string | Required within parent | Identifier field |
import_type | string | Optional | INITIAL (census import at company onboarding) or HISTORICAL (historical data imported later). Set only when event_type is IMPORT. Known values: INITIAL, HISTORICAL |
reason_code | string | Optional | Structured transition reason (e.g. ‘PROMOTION’, ‘MARKET_ADJUSTMENT’). Populated only when the company has configured transition reasons and the change went through a role transition with one selected. Null for most companies and events. |
referenced_transaction_id | string | Optional | For amendments or undos, the id of the worker-change event being modified. |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific worker change — response body — worker |
worker_id | string | Required within parent | The worker affected by this change. |
Referenced models: Retrieve a specific worker change — response body — changes item, Retrieve a specific worker change — response body — changed by, Retrieve a specific worker change — response body — worker