Skip to content

Rippling: List shift assignments — response body — results item

List shift assignments: response body, field results / item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: List shift assignments — response body — results item

FieldTypePresenceDescription and constraints
$objectRoot
can_editbooleanOptionalWhether the shift assignment can be edited
created_atstringRequired within parentRecord creation date
custom_fieldsarrayOptionalCustom fields for the shift assignment
custom_fields[]JSONEach itemAdditional keys: see wildcard field
custom_fields[].*JSONAdditional keys
idstringRequired within parentIdentifier field
is_publishedbooleanRequired within parentWhether the shift assignment is published. If true, the published_version will be the same as the shift_data
published_versionModelOptionalExpand Update a shift assignment — response body — published version
scheduleModelOptionalExpand Update a shift assignment — response body — schedule
schedule_idstringRequired within parentThe ID of the schedule
shift_dataModelRequired within parentExpand Update a shift assignment — response body — shift data
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Update a shift assignment — response body — worker
worker_idstringRequired within parentThe ID of the worker. Empty string ” to unassign if shift is from an open/empty shift.

Referenced models: Update a shift assignment — response body — published version, Update a shift assignment — response body — schedule, Update a shift assignment — response body — shift data, Update a shift assignment — response body — worker

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.