Retrieve a list

Returns a filtered list of paid presences.

Endpoint details

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/paid-presences

Headers: Authorization: Bearer {token}, User-Agent: {agent} Scope: connector-protimeapi-calculated-totals.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 paid presence record (read-only).
person.id	integer	—	Read-only	Internal ID of the person for whom this paid presence applies.
date	string	—	Read-only	Date for which the paid presence is recorded (YYYY-MM-DD).
durationInMinutes	integer	—	Read-only	Duration of the paid presence in minutes.
shiftDefinition.id	integer	—	Read-only	Internal ID of the linked shift definition (optional).

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 max of 1 year range)

Check the Fetching Resources page on how to use the filter.

External references

The endpoint supports predefined and custom external references. See the external references page for details and the predefined options list.

The following collections are supported for this endpoint:

Collection	Predefined	Custom
people	@badge-number, @employee-number	Supported
shift-definitions	@shift-code	Supported

Error responses

Status	Condition
400	Invalid filter syntax, unknown filter field, 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
414	Request URI too long (filter + continuation token)

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)