Retrieve a list

Introduction

You can retrieve a list of access clockings.

Endpoint details

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

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 access clocking.
person.id	integer	Internal ID of the person who performed the clocking.
date	string	Date of the access clocking (YYYY-MM-DD).
timeOfDayInMinutes	integer	Minutes since midnight (0 to 1439) representing the time of the clocking on the specified date.
terminal.id	integer	Internal ID of the terminal on which the clocking occurred.
status	string	Result of the access attempt (AccessOk, AccessRefused, WrongPinCode, AlarmCode, AntiPassbackError, OutZone, UnknownBadge).

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.

Good to know

Time of day

Access clockings always happen on the actual date itself. This is different from other clocking kinds, which have a notion of previous/current/next day.

Status values

A more detailed description of the possible values for the status property.

Value	Description
AccessOk	Access granted.
AccessRefused	Access denied.
WrongPinCode	PIN code verification failed.
AlarmCode	Alarm code entered (meaning may depend on configuration).
AntiPassbackError	Anti-passback rule violated (e.g., required entry/exit sequence not followed).
OutZone	Exited a defined zone (floor plan context; may depend on configuration).
UnknownBadge	Badge was unknown at the time of clocking. This can be reprocessed if the badge is later linked to a person, but the status remains UnknownBadge.

Examples

Filter on date range

Example with a date range:

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

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/access-clockings?filter=person in (1,2,3) and date ge '2025-01-01' and date le '2026-01-00' &externalReferences=(people,@employee-number)