Rippling: List worker change fields
Rippling restApi.listWorkerChangeFields: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.list_worker_change_fields
Provider route: GET /worker-change-fields/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["listWorkerChangeFields"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.restApi.listWorkerChangeFields(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_rippling import RipplingIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.rest_api.list_worker_change_fields(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
__meta | Model | Optional | Expand List Sites — response body — meta |
next_link | string | Optional | A link to the next page of responses. Format: uri |
results | array | Optional | |
results[] | Model | Each item | Expand List worker change fields — response body — results item |
Referenced models: List Sites — response body — meta, List worker change fields — response body — results item
Schemas
Section titled “Schemas”List Sites — response body — meta
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of redacted fields. |
redacted_fields | array | Optional | |
redacted_fields[] | object | Each item | |
redacted_fields[].name | string | Optional | The name for the redacted field |
redacted_fields[].reason | string | Optional | The reason for the redaction |
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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.list_worker_change_fields. Catalog operation: list-worker-change-fields. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["worker-change-fields.read"]
Provider entitlements: ["Worker_Changes_API"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}