v1/absences/locations

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

≥ 1

ID of a shyftplan account.

company_ids[]

array of int32s

Filter for a list of company IDs.

company_ids[]

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.

int32

≥ 1

Filter for a single location ID.

ids[]

array of int32s

Filter for a list of location IDs.

ids[]

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.

with_deleted

boolean

Defaults to false

Include soft-deleted locations

with_own

boolean

Boolean flag to determine if 'own locations' should be included in the response - those are the locations where the user can be assigned to shifts (as part of staff) at some position. The default value for this parameter is true, if the user is an employee (or both employee and manager), otherwise it is false.

200Successfully listed

400Bad request

401Unauthorized.

403Forbidden.

422Invalid request.