v1/qualifications/expirations/list

get

https://shyftplan.com/api/v1/qualifications/expirations/list

List company-wide qualifications that are expiring or have already expired.

Query Params

user_email

string

required

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

E-mail address of the API user.

authentication_token

string

required

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

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

employment_ids[]

array of objects

Filter for a list of employment IDs.

employment_ids[]

expiring_in_days

int32

≥ 1

Return qualifications whose effective expiration is at or before today + expiring_in_days. Use 0 to only include already-expired items.

include_expired

boolean

Defaults to true

When true (default), include items whose effective expiration is already in the past. Set to false to restrict the list to items expiring between today and today + expiring_in_days.

page

int32

≥ 1

Defaults to 1

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

per_page

int32

1 to 1000

Defaults to 500

Number of responses on each page.

qualification_ids[]

array of objects

Filter for a list of qualification IDs.

qualification_ids[]

Responses

200Successfully listed

401Unauthorized

403Forbidden

422Invalid request