Retrieve a list
Introduction
You can retrieve a list of activity durations 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/activity-durations
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 activity duration. |
person.id |
integer | Unique identifier of the person linked to this duration. |
date |
string | Date of the activity duration (YYYY-MM-DD). |
durationInMinutes |
integer | Duration in minutes for the activity. |
activityLevels.level |
integer | A list of levels in the activity structure of the registered activity definition. |
activityLevels.activityDefinition.id |
string | Unique identifier for the activity definition registered. |
absenceDefinition.id |
integer | Unique identifier for the absence definition, if an absence is linked to the duration. |
request.id |
string | Unique identifier for the request, if the duration was requested. |
counterDefinitions.id |
integer | A list of unique identifiers for the counter definitions or multiple definitions, if one or more counters are linked to this duration. |
shiftDefinition.id |
integer | Unique identifier for the shift definition, if a shift is linked to the duration. |
status |
string | Status of the activity duration (Unknown, Auto, Manual). |
isAuthorized |
boolean | Indicates if the activity duration is authorized. |
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 activity duration, 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 with external reference
Example with a date range and the employee number as the external reference for people:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/activity-durations?filter=date ge '2025-01-01' and date le '2026-01-01'&externalReferences=(people,@employee-number)
Filter on people and date range with multiple external references
Example with a filter on a few people, a date range and multiple external references:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/activity-durations?filter=person in (1,2,3) and date ge '2025-01-01' and date le '2025-01-05'&externalReferences=(people,@employee-number)(activity-definitions,@data-entry-code)(absence-definitions,@absence-code)(counter-definitions,@counter-code)