Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
applied_onstringRequired within parentWhen 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_byModelOptionalExpand Retrieve a specific worker change — response body — changed by
changed_by_idstringOptionalActor who made the change. Null for system-initiated events.
changesarrayRequired within parentField-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[]ModelEach itemExpand Retrieve a specific worker change — response body — changes item
created_atstringRequired within parentRecord creation date
effective_onstringRequired within parentWhen the change is true in the business domain. Can be past, present, or future. Independent of applied_on. UTC.
event_typestringRequired within parentThe 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
idstringRequired within parentIdentifier field
import_typestringOptionalINITIAL (census import at company onboarding) or HISTORICAL (historical data imported later). Set only when event_type is IMPORT.
Known values: INITIAL, HISTORICAL
reason_codestringOptionalStructured 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_idstringOptionalFor amendments or undos, the id of the worker-change event being modified.
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific worker change — response body — worker
worker_idstringRequired within parentThe 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.