v1

latestOpenAPI 3.0.02026-07-24310185.2 KB
Absences

List absences ๐ŸŒ

Returns the absences in a company. This list is paginated. The output can be filtered given some fields like contractId. By default, only approved absences are returned, but this can be changed by setting status filter.


Required scopes: time:read

get/companies/{companyId}/absences

Path parameters

companyIdstring required

The id of the company

Query parameters

nextPageTokenstring

The encoded pagination token

maxResultsstring

Allows to define the maximum number of items to fetch at once. (Max: 50, Default: 10)

contractIdstring

Filter by contractId.

statusstring

Filter by status. Defaults to approved. Multiple statuses can be provided, separated by commas, for example status=approved,pending_approval. If all is provided, all absences will be returned, regardless of their status. Possible statuses are: - approved - pending_approval - declined - cancelled - pending_cancellation

beginDatestring date

Defines the minimal begin date of absences to fetch. Every absences with params.beginDate <= absences.endDate will be included.

endDatestring date

Defines the maximal end date of absences to fetch. Every absences with params.endDate >= absences.startDate will be included.

Response

The absences of the collaborators in the company.