Retrieve a list
Returns a filtered list of validated hours.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/validated-hours
Headers: Authorization: Bearer {token}, User-Agent: {agent}
Scope: connector-protimeapi-hours-to-validate.read
Response properties
| Field | Type | Required | Writable | Description |
|---|---|---|---|---|
changeVersion |
string | — | Read-only | Property to indicate the order of changes. |
id |
integer | — | Read-only | Unique identifier for the validated hours record. |
person.id |
integer | — | Read-only | Internal ID of the person the validated hours belong to. |
date |
string | — | Read-only | Date the validated hours are registered on (YYYY-MM-DD). |
startTimeInMinutes |
integer | — | Read-only | Start time of the validated hours (minutes since midnight, between -1440 and 2880). |
endTimeInMinutes |
integer | — | Read-only | End time of the validated hours (minutes since midnight, between -1440 and 2880). |
durationInMinutes |
integer | — | Read-only | Duration of the validated hours, in minutes. |
Filters
| Filter | Type | Description |
|---|---|---|
person |
Optional | Internal person IDs (person in (1, 2, 3)), or the current members of circles (person in circle(2, 8)) or org-groups (person in org-group(121, 122)). When omitted, all people are returned. |
date |
Required | Date range (required, with a max of 1 year range) |
Note
- The
personfilter cannot be combined withdelta. A request with both returns400 Bad Request. - With a
personfilter, results are paged per 100 people. If the people matched by the filter change between pages (for example, a circle or org-group membership change), the next page returns409 Conflict; restart from the first request.
Both a start and an end date are required. Check the Fetching Resources page on how to use the filter.
Pagination
This endpoint supports pagination via continuationToken. The response includes a nextLink field when more results are available. Pass the continuationToken value as a query parameter to retrieve the next page.
External references
The endpoint supports predefined and custom external references. See the external references page for details.
The following collections are supported for this endpoint:
| Collection | Predefined | Custom |
|---|---|---|
people |
@badge-number, @employee-number |
Supported |
Error responses
| Status | Condition |
|---|---|
400 |
Invalid filter syntax, unknown filter field, missing date filter, or a person filter combined with delta |
401 |
Missing or invalid access token, or insufficient scope |
409 |
The people matched by the person filter changed between pages |
Examples
Filter on date range
Example with a date range:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/validated-hours?filter=date ge '2025-01-01' and date le '2025-01-31'
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/validated-hours?filter=person in (123,456) and date ge '2025-01-01' and date le '2025-01-31'&externalReferences=(people,@employee-number)
Filter on people in organisational groups
Example with the people of two organisational groups and a date range:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/validated-hours?filter=person in org-group (200,201) and date ge '2025-01-01' and date le '2025-01-31'