Skip to content

Rippling: List unassigned shifts — response body — results item

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

API reference · Contract 2026-10-28

SDK schema: List unassigned shifts — response body — results item

FieldTypePresenceDescription and constraints
$objectRoot
assigned_countJSONOptional
assigned_count (anyOf 1)integerAlternativeThe number of assigned shifts
assigned_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
assigned_shift_idsarrayOptionalThe IDs of the assigned shifts that are part of this unassigned shift
assigned_shift_ids[]stringEach item
created_atstringRequired within parentRecord creation date
custom_fieldsarrayOptionalCustom fields for the unassigned shift
custom_fields[]JSONEach itemAdditional keys: see wildcard field
custom_fields[].*JSONAdditional keys
idstringRequired within parentIdentifier field
is_publishedbooleanRequired within parentWhether the shift is published
open_shift_configobjectOptionalConfiguration for an open shift. If present, this is an open shift (workers can sign up). If absent/None, this is an empty shift (placeholder).
published_versionModelOptionalExpand Update a unassigned shift — 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
target_countJSONRequired within parent
target_count (anyOf 1)integerAlternativeThe target count of the shift
target_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentRecord update date

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

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.