Skip to main content
GET
Get one shift

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The shift's ID.

Query Parameters

for_person
string

Adds for_me to each role: whether this person may take it, why not, and which stretches are still free. A person's record ID, or me for the person who created the key.

Response

The shift.

id
string
required
starts_at
string<date-time>
required
ends_at
string<date-time>
required
status
enum<string>
required

open takes sign-ups. closed and cancelled do not.

Available options:
open,
closed,
cancelled
roles
object[]
required
tenant_id
string

Your organization's ID.

event_id
string | null

The schedule it belongs to, if any.

location_unit_id
string | null

Where it happens: one of your locations.

notes
string | null
custom_fields
string

Your own shift fields, as JSON text.

created_at
string<date-time>
updated_at
string<date-time>
deleted_at
string | null

Always null: a deleted shift is not returned.