v1/absences/employments

get

https://shyftplan.com/api/v1/absences/employments

List all employments which can be seen on absences.

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.

company_ids[]

array of objects

Filter for a list of company IDs.

company_ids[]

created_after

date-time

Filter to retrieve only employments that are created after this date-time.

created_before

date-time

Filter to retrieve only employments that are created before this date-time.

int32

≥ 1

Filter for an employment ID.

ids[]

array of int32s

Filter for a list of employment IDs.

ids[]

order_key

string

enum

Defaults to last_name

Sort responses by this key.

Allowed:

order_dir

string

enum

Defaults to asc

Sorting order.
Available options:

asc: Ascending order
desc: Descending order

Allowed:

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.

string

Filter to retrieve only employees whose name or staff number includes the search string.

updated_after

date-time

Filter to retrieve only employments that are updated after this date-time.

updated_before

date-time

Filter to retrieve only employments that are updated before this date-time.

with_deleted

boolean

Defaults to false

Include soft-deleted employments in the response?

Response

200List all Employments which can be seen on Absences.