Skip to main content
POST
Open a shift

Authorizations

Authorization
string
header
required

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

Body

application/json
starts_at
string<date-time>
required

A date and time.

ends_at
string<date-time>
required

A date and time after starts_at.

roles
object[]
required

At least one, and each role once.

event_id
string | null

The schedule to put it under.

location_unit_id
string | null

One of your locations.

notes
string | null

Response

The shift, as it was opened.

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.