Retrieve a list

Returns a list of all absence groups.

Tip

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

Endpoint details

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

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

Response properties

Field Type Required Writable Description
changeVersion string — Read-only Property to indicate the order of changes.
id integer — Read-only Internal unique identifier for the absence group.
name.default string — Read-only Default name value of the absence group.
name.translations object — Read-only A list of translated names of the absence group by language code.
type string — Read-only The type of the absence group (Absence, WorkingElsewhere, Unknown).

Filters

This endpoint does not support filters. It always returns all absence groups. A request that includes the filter query parameter is rejected with 400 Bad Request.

To retrieve one absence group, use Retrieve an absence group.

External references

This endpoint does not support external references.

Error responses

Status Condition
400 Unsupported query parameter, such as filter
401 Missing or invalid access token, or insufficient scope

Examples

Retrieving all absence groups

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