v2/absence_entitlements

get

https://shyftplan.com/api/v2/absence_entitlements

List absence entitlements per employee and absence reason.

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.

year

int32

required

2000 to 2100

Filter for a specific Year between 2000 and 2100

company_ids[]

array of objects

Filter for a list company IDs.

company_ids[]

absence_reason_ids[]

array of objects

Filter for a list of absence reason IDs to retrieve only absence entitlements for these absence reason IDs.

absence_reason_ids[]

employment_ids[]

array of objects

Filter for a list of employment IDs to retrieve only absence entitlements for these employees.

employment_ids[]

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.

with_deleted

boolean

Defaults to true

Include soft-deleted employments?

true: Include soft-deleted employments.
false: Don't include soft-deleted employments.

Responses

200Successfully listed

401Unauthorized