Rippling: Retrieve a specific worker change

← rest_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.rest_api.get_worker_changes

Provider route: GET /worker-changes/{id}/. Alter supplies the connection’s credentials and routing.

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"]["getWorkerChanges"]>[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.getWorkerChanges(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from 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.get_worker_changes(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Format: id
query	object	Optional	Additional keys: not allowed
query.expand	string	Optional

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	object	Optional
__meta.redacted_fields	array	Optional
__meta.redacted_fields[]	Model	Each item	Expand Retrieve a report run — response body — meta redacted fields item
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 report run — response body — meta redacted fields item, 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

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.get_worker_changes. Catalog operation: get-worker-changes. 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-changes.read"]

Provider entitlements: ["Worker_Changes_API"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source