Retrieve a counter

Introduction

You can retrieve a counter by the internal ID using the GET call.

Endpoint details

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/counters/{id}

URL parameters

This parameter needs to be filled in when calling this endpoint.

Parameter	Description
<id>	The internal ID of the counter.

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 counter instance.
shiftDefinition.id	integer	Unique identifier for the shift definition, if a shift is linked to this counter.
numberOfInstances	integer	Number of counter instances.
request.id	string	Internal unique identifier for the related request, if the counter was requested.
status	string	Status of the counter instance (Unknown, Auto, Manual, Calendar).
isAuthorized	boolean	Indicates if the counter instance is authorized.
person.id	integer	Unique identifier for the person linked to this counter.
periodType	string	Type of period the counter applies to (Unknown, Day, Week, PayPeriod).
counterDefinition.id	integer	Unique identifier for the counter definition linked to this counter.
date	string	Date of the counter instance that it is registered on.
startTimeInMinutes	integer	Start time in minutes from midnight.
endTimeInMinutes	integer	End time in minutes from midnight.
durationInMinutes	integer	Duration of the counter instance in minutes.

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

Shift definition behaviour

The shiftDefinition property is typically linked to the counter, unless the shift is inherited from the schedule.

Examples

Retrieving a counter

Example with a counter ID 905165:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/counters/905165

With external reference

Example with external reference for the counter definition:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/counters/905165?externalReferences=(counter-definitions,@counter-code)