Rippling: Retrieve a specific worker change — response body — changes item
Retrieve a specific worker change: response body, field changes / item. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: Retrieve a specific worker change — response body — changes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_type | string | Required within parent | VISIBLE or REDACTED. REDACTED means the caller’s role lacks permission to read this field; from_value/to_value are null but the entry still appears so consumers know a change occurred. Known values: VISIBLE, REDACTED |
field_display_name | string | Required within parent | UI label for the field (English). |
field_key | string | Required within parent | Field key in snake_case. |
from_value | string | Optional | Value before the change, rendered as a display string (locale- and currency-formatted per the activity-log convention). Null when display_type is REDACTED. Typed JSON values are tracked as a future addition; consult value_type to interpret the rendering. |
to_value | string | Optional | Value after the change, rendered as a display string. Null when display_type is REDACTED. See from_value for notes on typed-value plans. |
value_type | string | Required within parent | The underlying value type of this field. Populated regardless of display_type so consumers can interpret from_value / to_value or anticipate a future typed representation. Known values: STRING, NUMBER, BOOLEAN, DATE, DATETIME, CURRENCY, ENUM, REFERENCE |