v1/availabilities

get

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

List 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.

created_after

date-time

Return all records which are created after this date-time.

created_before

date-time

Return all records which are created before this date-time.

employment_id

int32

≥ 1

Filter for a single employment ID.

employment_ids[]

array of int32s

Filter for a list of employment IDs.

employment_ids[]

ends_at

date-time

Return all availabilities which can be applied to the timeframe. Required if starts_at is set.

int32

≥ 1

Filter for single Availability ID.

ids[]

array of int32s

Filter for a list of availability IDs.

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.

starts_at

date-time

Return all availabilities which can be applied to the timeframe. Required if ends_at is set.

updated_after

date-time

Return all records which are updated after this date-time.

updated_before

date-time

Return all records which are updated before this date-time.

Response

200Availabilities successfully listed.