API Reference
Home

v1/qualifications/locations_positions

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

List locations positions with their qualifications.

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

Filter to retrieve only locations positions and their qualifications a for a particular location ID

locations_position_ids[]
array of objects

Filter for a list of locations positions IDs.

locations_position_ids[]
string
enum

Context of the qualification. Global qualifications can be assigned to any position, locations_position qualifications have to be made specifically available to a position first.

Allowed:
qualification_category_ids[]
array of objects

Filter for a list of qualification category IDs.

qualification_category_ids[]
qualification_ids[]
array of objects

List of the IDs of qualifications.

qualification_ids[]
boolean
Defaults to false

Boolean filter for expiring (true) or non-expiring (false) qualifications

boolean
Defaults to false

Filter for employments with timed qualification that will expire soon

boolean
Defaults to false

Filter for employments with timed qualification that are expired

boolean
Defaults to false

Filter for employments with planned qualification that are due in some point in the future

boolean
Defaults to false

Filter for employments with planned qualification that are due soon

boolean
Defaults to false

Filter for employments with planned qualification that are overdue,

Responses

Updated 6 months ago

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

Updated 6 months ago