Skip to main content
GET
List sign-ups

Authorizations

Authorization
string
header
required

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

Query Parameters

status
string

One or more of booked, cancellation_requested, cancelled, attended, no_show, separated by commas. Without it, every status but cancelled.

person_id
string

The sign-ups of one person (not the ones they accompany).

window_id
string

The sign-ups on one shift.

role_id
string

The sign-ups for one role.

location_unit_id
string

The sign-ups on shifts at one location.

from
string

Sign-ups that end on or after this date, or date and time.

to
string

Sign-ups that start on or before this date, or date and time.

signed_off
enum<string>

false for the hours still waiting to be signed off.

Available options:
true,
false
limit
integer
default:50

How many to return. 50 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 sign-ups.

results
object[]
required
total
integer
required

How many sign-ups match in all.

limit
integer
required
offset
integer
required
has_more
boolean
required

Whether there is another page after this one.