v1/locations

get

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

List all Locations.

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.

company_ids[]

array of int32s

Filter an array of Company IDs

company_ids[]

created_after

date-time

Return all records which are created after

created_before

date-time

Return all records which are created before

int32

Filter for single Location ID

ids[]

array of int32s

Filter an array of Location IDs

ids[]

updated_after

date-time

Return all records which are updated after

updated_before

date-time

Return all records which are updated before

with_deleted

boolean

Defaults to false

Include soft deleted locations

with_own

boolean

Include own locations. This defaults to false, if the requesting user is not an employee, and to true, otherwise. For true, the response will include locations in the list that contain a position where the user can be assigned to shifts.

Responses

200Successfully listed

422The request is invalid