v1
latestOpenAPI 3.0.22026-07-144652931.4 MBSchedules_v3
Get a custom shift
<!-- theme: info -->Important note: Shift-based schedules use the V3 API and are not compatible with V2 automations. To create automations for Shift-Based Schedules, you need to:
- Update your automations to use the V3 API for all new shift-based schedules
- Keep the V2 endpoint for your existing schedules
An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. Learn more.
Retrieve a single custom shift by ID.
get/v3/schedules/{id}/custom_shifts/{custom_shift_id}
Path parameters
idstring required
The ID of the schedule.
custom_shift_idstring required
The ID of the custom shift.
Response
Custom shift retrieved successfully
Example response
{
"custom_shift": {
"start_time": "2025-03-15T09:00:00Z",
"end_time": "2025-03-15T17:00:00Z",
"assignments": [
{
"member": {
"user_id": "PUSER123"
}
}
]
}
}