API Reference
Home

v1/employments/{id}/available_locations

get
https://shyftplan.com/api/v1/employments//available_locations

Get all locations that have positions to which a specific employee can be assigned, so that they can then be staffed on shifts at those positions.

Path Params
int32
required
≥ 1

ID of the employment.

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.

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.

string

Search string to filter locations by name

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?