Rippling: List worker change fields — response body — results item
List worker change fields: response body, field results / item. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: List worker change fields — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category | string | Required within parent | High-level grouping for the field. Known values: PERSONAL, JOB, COMPENSATION, BENEFITS, CUSTOM, COUNTRY_SPECIFIC |
field_display_name | string | Required within parent | UI label for the field (English). |
field_key | string | Required within parent | Field key in snake_case. Use directly in ?filter=field_key eq ’…’ on GET /worker-changes. Naming convention: public DTO fields use the DTO field name verbatim (work_email, title); nested fields use dot notation (compensation.base_salary); custom fields use custom_fields.<custom_field_id>; country-specific fields use country_fields.<field_name>. Filter semantics: filtering GET /worker-changes by field_key returns events that contain at least one change to this field, but the changes[] array on those events is NOT pruned — consumers receive the full event payload including changes to other fields. |
value_type | string | Required within parent | Value type of the field. Known values: STRING, NUMBER, BOOLEAN, DATE, DATETIME, CURRENCY, ENUM, REFERENCE |