API Reference
Home

v1/qualifications/grouped_by_category

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

List all Qualifications grouped by category

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.

locations_position_ids[]
array of objects

Filter by a list of IDs of locations positions.

locations_position_ids[]
qualification_category_ids[]
array of objects

Filter by a list of IDs of qualification categories.

qualification_category_ids[]
int32
≥ 1

Filter by a list of qualification IDs.

boolean
Defaults to false

Filter for timed qualifications that will expire for at least one employment at some point in the future.

boolean
Defaults to false

Filter for timed qualifications that will expire soon (as defined in the company profile in shyftplan) for at least one employment.

boolean
Defaults to false

Filter for timed qualifications that have expired for at least one employment.

boolean
Defaults to false

Filter for qualifications that are due to be achieved by at least one employment at some point in the future.

boolean
Defaults to false

Filter for qualifications that are due to be achieved soon (as defined in the company profile in shyftplan) for at least one employment.

boolean
Defaults to false

Filter for qualifications that are overdue to be achieved for at least one employment.

Responses

Updated about 1 month ago

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

Updated about 1 month ago