Retrieve a list
Introduction
You can retrieve a list of absences using a filter.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/absences
Response properties
This list of properties is returned by this endpoint.
| Property | Type | Description |
|---|---|---|
changeVersion |
string | Property to indicate the order of changes. |
id |
integer | Unique identifier for the absence instance. |
person.id |
integer | Internal ID of the person for whom the absence is registered. |
resultingAbsenceDefinition.id |
integer | Internal ID of the resulting absence definition. |
requestedAbsenceDefinition.id |
integer | Internal ID of the originally requested absence definition. |
shiftDefinition.id |
integer | Internal ID of the shift definition for the absence. |
date |
string | Date of the absence (YYYY-MM-DD). |
startTimeInMinutes |
integer | Start time of the absence in minutes since midnight. |
durationInMinutes |
integer | Duration of the absence in minutes. |
calculatedDurationInMinutes |
integer | Calculated duration of the absence in minutes. |
dayPart |
string | Part of the day the absence applies to (First, Second, Unknown). |
request.id |
string | ID of the related absence request, formatted as {TenantId}-{PersonId}-{RequestId}. |
status |
string | How the absence was registered (Manual, Auto, BeginOpen, Open, Terminal, Calendar). |
approvalLevel |
string | Approval status (Approved, NotApproved, NotApprovedByPriorities, NotApprovedByCalculations, AwaitingApproval). |
isLocked |
boolean | Indicates if the absence is locked and cannot be changed. |
periodType |
string | Type of period the absence applies to (Unknown, Day, Week, PayPeriod). |
Filters
This list of filters can be used for this endpoint. Some filters are mandatory.
| Filter | Type | Description |
|---|---|---|
person |
Optional | Filter by specific person IDs |
date |
Required | Date range (required with max of 1 year range) |
Check the Fetching Resources page on how to use the filter.
External references
It’s possible to use predefined external references and custom external references. More information can be found on the External References Page
For a list of predefined external references, see the external reference options section.
Note
Check the query options below the endpoint on the Swagger page for the relevant external references.
Good to know
Shift definition behaviour
The shiftDefinition property is typically linked to the absence, unless the shift is inherited from the schedule.
Tip
In cases where the shift comes from the schedule, the shiftDefinition is not included in the response. If the shift isn’t inherited from the schedule, the shiftDefinition will be included in the response.
Examples
Filter on date range
Example with a date range between the 1st of January 2025 and 1st of January 2026:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/absences?filter=date ge '2025-01-01' and date le '2026-01-01'
Filter on people and date range with external reference
Example with people and absence code:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/absences?filter=person in (1,2,3) and date ge '2025-01-01' and date le '2026-01-01' &externalReferences=(absence-definitions,@absence-code)