Skip to main content
GET
List shifts

Authorizations

Authorization
string
header
required

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

Query Parameters

location_unit_id
string

Shifts at one location.

event_id
string

The shifts of one schedule.

status
enum<string>
Available options:
open,
closed,
cancelled
from
string

Shifts that end on or after this date, or date and time.

to
string

Shifts that start on or before this date, or date and time.

role_id
string

Shifts that offer this role.

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.

limit
integer
default:200

How many to return. 200 unless you say, 200 at most.

Required range: 1 <= x <= 200
offset
integer
default:0

How many to skip, for the next page.

Required range: x >= 0

Response

One page of shifts.

results
object[]
required
limit
integer
required
offset
integer
required
has_more
boolean
required

Whether there is another page after this one.

total
integer
required

How many shifts match in all.