Retrieve a list
Introduction
You can retrieve a list of counters 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/counters
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 counter instance. |
shiftDefinition.id |
integer | Unique identifier for the shift definition, if a shift is linked to this counter. |
numberOfInstances |
integer | Number of counter instances. |
request.id |
string | Internal unique identifier for the related request, if the counter was requested. |
status |
string | Status of the counter instance (Unknown, Auto, Manual, Calendar). |
isAuthorized |
boolean | Indicates if the counter instance is authorized. |
person.id |
integer | Unique identifier for the person linked to this counter. |
periodType |
string | Type of period the counter applies to (Unknown, Day, Week, PayPeriod). |
counterDefinition.id |
integer | Unique identifier for the counter definition linked to this counter. |
date |
string | Date of the counter instance that it is registered on. |
startTimeInMinutes |
integer | Start time in minutes from midnight. |
endTimeInMinutes |
integer | End time in minutes from midnight. |
durationInMinutes |
integer | Duration of the counter instance in minutes. |
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) |
counter-definitions |
Optional | Filter by specific counter definition IDs |
status |
Optional | Filter by one or more status values |
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 behavior
The shiftDefinition property is typically linked to the counter, 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 5th of January 2025:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/counters?filter=date ge '2025-01-01' and date le '2025-01-05'
Filter on people and date range with external reference
Example with people and counter code:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/counters?filter=person in (1,2,3) and date ge '2025-01-01' and date le '2025-01-05' &externalReferences=(people,@employee-number)(counter-definitions,@counter-code)