API Reference
Home

v1/qualifications/employments

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

List all employments as they can be seen on the qualification matrix, with limited detail (showing staff-number, first name, etc.).

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
required
≥ 1

ID of a location.

employment_ids[]
array of objects

Filter for a list of employment IDs.

employment_ids[]
tag_ids[]
array of objects

Filter for a list of employment-tag IDs.

tag_ids[]
int32
≥ 1

ID of the locations position to sort by, showing employees first who are assigned to this locations position, and sorting these by number of achieved qualifications for this locations position.

boolean
Defaults to false

Filter for employments with a timed qualification that will expire at some point in the future.

boolean
Defaults to false

Filter for employments with a timed qualification that will expire soon (interval defined in company profile in shyftplan).

boolean
Defaults to false

Filter for employments with a timed qualification that has expired.

boolean
Defaults to false

Filter for employments with a planned qualification that is due to be achieved at some point in the future

boolean
Defaults to false

Filter for employments with a planned qualification that is due to be achieved soon (interval defined in company profile in shyftplan).

boolean
Defaults to false

Filter for employments with a planned qualification that is overdue.,

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.

shift_rotation_group_ids[]
array of objects

Filter for employments from specific shift-system groups, specified by the groups' IDs

shift_rotation_group_ids[]
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?