Retrieve a list
Introduction
You can retrieve a list of breaks 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/breaks
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 break record. |
person.id |
integer | Internal ID of the person this break belongs to. |
breakDefinition.id |
integer | Internal ID of the linked break definition. |
date |
string | Date for which the break is recorded (YYYY-MM-DD). |
calculatedDurationInMinutes |
integer | Calculated duration of the break in minutes. |
clockedDurationInMinutes |
integer | Actual clocked duration of the break in minutes. |
startTimeInMinutes |
integer | Earliest start time from the break definition (minutes since midnight). |
endTimeInMinutes |
integer | Latest end time from the break definition (minutes since midnight). |
isBreakTaken |
boolean | Indicates whether the break was taken. |
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.
Examples
Filter on date range
Example with a date range:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/breaks?filter=date ge '2024-01-01' and date le '2024-01-05'
Filter on people and a date range with external reference
Example with people, a date range and the employee number as an external reference:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/breaks?filter=date ge '2024-01-01' and date le '2024-01-05' &externalReferences=(people,@employee-number)