API Reference
Home

v1/absences/stats

get
https://shyftplan.com/api/v1/absences/stats

Return aggregated absence days for each absence reason.

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.

date-time

Start of the search period. The report will include only absences that at least partially overlap with the search period.

date-time

End of the search period. The report will include only absences that at least partially overlap with the search period.

employment_ids[]
array of objects

Filter for a list of employment IDs to include only absences for these employees. To include information about the year's entitlement or used/available carry-over days (remaining entitlement from the previous year), include a single employment ID.

employment_ids[]
location_ids[]
array of objects

Filter for a list of location IDs to include only absences of employees that can work at a position included in one of these locations.

location_ids[]
boolean | null

Filter to include absences based on presence of an attached file.

    Available options:
  • true: Only include absences with an attachment.
  • false: Only include absences with no attachment.
  • (empty value): Filter disabled.

boolean

Filter to include only paid (absence hours count as working time) or only unpaid absences.

    Available options:
  • true: Only include paid absences.
  • false: Only include unpaid absences.
  • (empty value): Filter disabled.

locations_position_ids[]
array of int32s

Filter for a list of locations position IDs to include only absences for employees who can work at any of the locations posititons specified.

locations_position_ids[]
states[]
array of objects

Filter for a list of absence states to include only absences with one of these states.

states[]
absence_reason_ids[]
array of objects

Filter for a list of absence reason IDs to retrieve only absences with one of the absence reason IDs specified.

absence_reason_ids[]
employment_statuses[]
array of objects

Filter for a list of employment statuses to include only absences of employees with one of these status.

employment_statuses[]
employment_tag_ids[]
array of int32s

Filter for a list of employment tag IDs to include only absences of employees with one of these tags.

employment_tag_ids[]
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