API Reference
Home

v1/locations_positions

get
https://shyftplan.com/api/v1/locations_positions

List all LocationsPositions.

Query Params
string
required

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

E-mail address of the API user.

string
required

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

Authentication token - can be fetched by login action.

int32
required
≥ 1

ID of a shyftplan account.

company_ids[]
array of int32s

Filter for an array of Company IDs.

company_ids[]
date-time

Return all records which are created after

date-time

Return all records which are created before

int32

Filter for single LocationsPosition ID

ids[]
array of int32s

Filter an array of LocationsPosition ID

ids[]
int32

Filter for single Location ID

location_ids[]
array of int32s

Filter an array of Location ID

location_ids[]
int32
≥ 1
Defaults to 1

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

int32
1 to 1000
Defaults to 500

Number of responses on each page.

int32

Filter for single Position ID

position_ids[]
array of int32s

Filter an array of Position ID

position_ids[]
date-time

Return all records which are updated after

date-time

Return all records which are updated before

boolean
Defaults to false

Include soft-deleted LocationsPositions

boolean

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

Responses

Updated 3 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?