Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Absences

Get a list of absences

Retrieve a paged collection of absence records (required scope resources:read)

get/v1/absences

Query parameters

resourceIdinteger

Only return absences for the resource with this identifier

dateFromstring date-time

Only return absences starting on or after this date

dateTostring date-time

Only return absences ending on or before this date

status'requested' | 'queried' | 'rejected' | 'approved'

The status of a resource absence<p>Possible values:</p><ul><li><b>requested</b>: The absence has been requested by the resource</li><li><b>queried</b>: The absence has been queried and requires review</li><li><b>rejected</b>: The absence has been rejected</li><li><b>approved</b>: The absence has been approved</li></ul>

Example:requested

Only return absences with this status

absenceTypeIdinteger

Only return absences of this absence type

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}