Retrieve an absence group

Introduction

You can retrieve an absence group by the internal ID or an external reference using the GET call. Internal IDs for absence groups can be found by listing all absence groups using the GET collection endpoint.

Endpoint details

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/absence-groups/{absenceGroupReference}

URL parameters

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

Parameter	Description
<absenceGroupReference>	The internal ID or external reference of the absence group.

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	Internal unique identifier for the absence group.
name.default	string	Default name value of the absence group.
name.translations	object	A list of translated names of the absence group by language code.
type	string	The type of the absence group (Absence, WorkingElsewhere).

External references

It’s possible to use custom external references. More information can be found on the External References Page.

The following collections are supported for this endpoint:

Collection	Predefined	Custom
absence-groups	Not available	Supported

Examples

Retrieving an absence group by internal ID

Example with internal ID 2:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/absence-groups/2

With custom external reference

Example with custom external reference SICK-LEAVE:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/absence-groups/SICK-LEAVE?externalReferences=(absence-groups,customAbsenceGroupCode)