v1/availabilities/exceptions

get

https://shyftplan.com/api/v1/availabilities/exceptions

List exceptions of availabilities.

Query Params

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

availability_id

int32

≥ 1

Filter for a single availability ID.

availability_ids[]

array of int32s

Filter for a list of availability IDs.

availability_ids[]

created_after

date-time

Return all records which are created after this date-time (ISO 8601).

created_before

date-time

Return all records which are created before this date-time (ISO 8601).

int32

≥ 1

Filter for an ID of an exception to a repeated availability.

ids[]

array of int32s

Filter for a list of IDs of exceptions to repeated availabilities.

ids[]

page

int32

≥ 1

Defaults to 1

Number of the page of responses to retrieve. First page: 1.

per_page

int32

1 to 1000

Defaults to 500

Number of responses on each page.

updated_after

date-time

Return all records which are updated after this date-time (ISO 8601).

updated_before

date-time

Return all records which are updated before this date-time (ISO 8601).

Response

200Successfully listed exceptions to repeated availabilities.