Retrieve a delta

Reference

Collections

Access clockings

Retrieve a delta

Returns access clockings that have changed since the last delta token.

Caution

Read the Delta page. There is important information on required implementation!

Tip

Check the Swagger page for more technical information on the endpoints.

Endpoint details

GET

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/access-clockings?delta

Headers: Authorization: Bearer {token}, User-Agent: {agent} Scope: connector-protimeapi-access-clockings.read

Field	Type	Required	Writable	Description
`changeVersion`	string	—	Read-only	Property to indicate the order of changes.
`id`	integer	—	Read-only	Unique identifier for the access clocking.
`person.id`	integer	—	Read-only	Internal ID of the person who performed the clocking.
`date`	string	—	Read-only	Date of the access clocking (YYYY-MM-DD).
`timeOfDayInMinutes`	integer	—	Read-only	Minutes since midnight (0 to 1439) representing the time of the clocking on the specified date.
`terminal.id`	integer	—	Read-only	Internal ID of the terminal on which the clocking occurred.
`status`	string	—	Read-only	Result of the access attempt (`AccessOk`, `AccessRefused`, `WrongPinCode`, `AlarmCode`, `AntiPassbackError`, `OutZone`, `UnknownBadgeNumber`).

Filter	Type	Description
`date`	Required	The start date must be a recent date in the past, with the earliest allowed start date being January 1st of the previous year

Note

The person filter cannot be combined with delta: a delta always covers all people. A request with both returns 400 Bad Request.
The start date must be a recent date in the past, with the earliest allowed start date being January 1st of the previous year
The end date is not required; when providing an end date there is a max range of 1 year

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
`terminals`	`@external-code`	Supported

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
`410`	Delta token has expired (older than 72 hours)
`414`	Request URI too long

Example for access clockings with a delta starting from 1st of January 2025:

GET

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/access-clockings?filter=date ge '2025-01-01'&delta