Retrieve a break

Introduction

You can retrieve a break by its internal ID using the GET call. Internal IDs for breaks can be found by listing all breaks using the GET collection endpoint.

Endpoint details

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

URL parameters

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

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

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 break record.
person.id	integer	Internal ID of the person this break belongs to.
breakDefinition.id	integer	Internal ID of the linked break definition.
date	string	Date for which the break is recorded (YYYY-MM-DD).
calculatedDurationInMinutes	integer	Calculated duration of the break in minutes.
clockedDurationInMinutes	integer	Actual clocked duration of the break in minutes.
startTimeInMinutes	integer	Earliest start time from the break definition (minutes since midnight).
endTimeInMinutes	integer	Latest end time from the break definition (minutes since midnight).
isBreakTaken	boolean	Indicates whether the break was taken.

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.

Examples

Retrieving a break by internal ID

Example with internal ID 112568:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/breaks/112568

With external reference for people

Example with internal ID 112568 and the employee number as an external reference:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/breaks/112568?externalReferences=(people,@employee-number)