Skip to content

Rippling: List worker changes

Rippling restApi.listWorkerChanges: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.list_worker_changes

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

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"]["listWorkerChanges"]>[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.listWorkerChanges(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.list_worker_changes(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.filterstringOptional
query.expandstringOptional
query.order_bystringOptional
query.limitintegerOptionalDefault: 50
Maximum: 100
Minimum: 1
query.cursorstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRoot
__metaModelOptionalExpand List Sites — response body — meta
next_linkstringOptionalA link to the next page of responses.
Format: uri
resultsarrayOptional
results[]ModelEach itemExpand List worker changes — response body — results item

Referenced models: List Sites — response body — meta, List worker changes — response body — results item

22 more schemas are linked from the tables above, on the schema pages.

List Sites — response body — meta
FieldTypePresenceDescription and constraints
$objectRootA list of redacted fields.
redacted_fieldsarrayOptional
redacted_fields[]objectEach item
redacted_fields[].namestringOptionalThe name for the redacted field
redacted_fields[].reasonstringOptionalThe reason for the redaction
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

Retrieve a specific worker change — response body — changes item
FieldTypePresenceDescription and constraints
$objectRoot
display_typestringRequired within parentVISIBLE 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_namestringRequired within parentUI label for the field (English).
field_keystringRequired within parentField key in snake_case.
from_valuestringOptionalValue 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_valuestringOptionalValue after the change, rendered as a display string. Null when display_type is REDACTED. See from_value for notes on typed-value plans.
value_typestringRequired within parentThe 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
Retrieve a specific worker — response body — business partners item
FieldTypePresenceDescription and constraints
$objectRoot
business_partner_groupobjectOptionalBusiness partner group the business partner is a part of

Expandable field
business_partner_group.created_atstringRequired within parentRecord creation date
business_partner_group.default_business_partnerModelOptionalExpand Retrieve a specific worker — response body — manager
Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.

Expandable field
business_partner_group.default_business_partner_idstringOptionalId of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.
business_partner_group.domainstringOptionalType of business partner group
Known values: HR, IT, FINANCE, RECRUITING, OTHER
business_partner_group.idstringRequired within parentIdentifier field
business_partner_group.namestringRequired within parentName used to identify business partner group
business_partner_group.updated_atstringRequired within parentRecord update date
business_partner_group_idstringRequired within parentIdentifier of business partner group the business parter is a part of
client_groupModelOptionalExpand Create a new business partner — response body — client group
client_group_idstringOptionalIdentifier of group of workers associated with the business partner
client_group_member_countJSONOptional
client_group_member_count (anyOf 1)integerAlternativeNumber of workers associated with the business partner
client_group_member_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific worker — response body — manager
Worker who is the business partner

Expandable field
worker_idstringRequired within parentIdentifier of worker who is the business partner

Referenced models: Retrieve a specific worker — response body — manager, Create a new business partner — response body — client group

Update a team — response body — parent
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the team.
parentModelOptionalExpand Update a team — response body — parent
The parent team

Expandable field
parent_idstringOptionalThe parent team
updated_atstringRequired within parentRecord update date

Referenced models: Update a team — response body — parent

Retrieve a specific worker — response body — work schedule value
FieldTypePresenceDescription and constraints
$objectRootThe scheduled working hours for a day of the week.
hoursJSONOptional
hours (anyOf 1)numberAlternativeThe number of scheduled working hours for the day.
hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Retrieve a specific worker — response body — country fields
FieldTypePresenceDescription and constraints
$objectRootCountry level fields for the worker.
caobjectOptionalCountry-wise regional fields for Canada
ca.sinstringOptionalSocial Insurance Number (SIN) for Canada employees.
nzobjectOptionalCountry-wise regional fields for New Zealand
nz.ird_numberstringOptionalInland Revenue Department (IRD) number for New Zealand employees.
usobjectOptionalCountry-wise regional fields for USA
us.ssnstringOptionalSocial Security Number (SSN) for US employees.
Retrieve a specific user — response body — emails item
FieldTypePresenceDescription and constraints
$objectRoot
displaystringOptionalThe display value of the email address.
typestringOptionalThe classification of the email.
Known values: HOME, WORK, OTHER
valuestringOptionalA valid email address.
Retrieve a specific user — response body — photos item
FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalThe classification of the photo.
Known values: PHOTO, THUMBNAIL
valuestringOptionalThe URL of the photo.

SDK function policy ID: rippling.rest_api.list_worker_changes. Catalog operation: list-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

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.