Retrieve a list
Introduction
You can retrieve a list of paid presences using a filter. A paid presence represents the paid time for a person on a specific date, which can be divided across one or multiple shifts depending on the configuration.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/paid-presences
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 paid presence record (read-only). |
person.id |
integer | Internal ID of the person for whom this paid presence applies. |
date |
string | Date for which the paid presence is recorded (YYYY-MM-DD). |
durationInMinutes |
integer | Duration of the paid presence in minutes. |
shiftDefinition.id |
integer | Internal ID of the linked shift definition (optional). |
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
Multiple instances per day
Unlike calculated totals which return a single record per person per day, paid presences can return multiple records for the same person on the same date. This happens when the paid presence is divided across multiple shifts based on the configuration in myProtime.
Shift definition behaviour
The shiftDefinition is optional and will be included when the paid presence is associated with a specific shift. If no shift is assigned, this field will be omitted from the response.
Examples
Filter on date range
Example with a date range:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/paid-presences?filter=date ge '2025-01-01' and date le '2025-01-31'
Filter on people and a date range
Example with people and a date range:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/paid-presences?filter=person in (3214,3215) and date ge '2025-01-01' and date le '2025-01-31'
Filter with external reference
Example with a date range and the employee number as an external reference:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/paid-presences?filter=date ge '2025-01-01' and date le '2025-01-31'&externalReferences=(people,@employee-number)