Unified HRIS API

Retrieve all absences.

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: (id IN ids) AND (remote_id IN remote_ids)

get/hris/absences

Request

Query parameters

cursorstring

An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.

page_sizeinteger

The number of results to return per page. Maximum is 250.

updated_afterstring date-time

Filter the entries based on the modification date in format YYYY-MM-DDTHH:mm:ss.sssZ. Returns records where either the record itself OR its nested data has been updated since this timestamp, even if the record's own changed_at field remains unchanged.

If you want to track entry deletion, also set the include_deleted=true query parameter, because otherwise, deleted entries will be hidden.

For more details, see Understanding changed_at vs updated_after Behavior.

For this endpoint, updated_after matches when the returned record changed, or when related data changed as described below.

PathAdded/RemovedLinked Record
typen/a✓ Yes

Added/Removed: Whether adding or removing entries from this list triggers an update (n/a for single records). Linked Record: Whether changes to the linked record itself trigger an update.

include_deleted'true' | 'false'

By default, deleted entries are not returned. Use the include_deleted query param to include deleted entries too.

ignore_unsupported_filters'true' | 'false'

When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.

idsstring

Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.

remote_idsstring

Filter by a comma-separated list of remote IDs.

date_fromstring date-time

Filter for all the absences that either start or haven't ended yet on/after this day. If you imagine a calendar displaying absences, this defines the left-most visible day. This is a plain date (i.e., yyyy-MM-dd), all time information is discarded.

date_untilstring date-time

Filter for absences that start on or before this day (but might continue after). If you imagine a calendar displaying absences, this defines the right-most visible day. This is a plain date (i.e., yyyy-MM-dd), all time information is discarded.

type_idsstring

Filter by a comma-separated list of absence type IDs.

employee_idstring

Filter by a specific employee using their ID.

time_fromstring date-time

(⚠️ Deprecated - Use the date_from filter instead.) Filter for absences that either start after or start before and end after a certain time.

time_untilstring date-time

(⚠️ Deprecated - Use the date_until filter instead.) Filter for absences that start before a certain time.

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Response

GET /hris/absences Positive response

status'success' required

Example response

{
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "22st2Ji8XpncEYEak8mvQgQF",
        "remote_id": "1348",
        "employee_id": "JDdUy9kiH5APaGizFrgNmQjM",
        "approver_id": "AgXEispYPP1BbToHpqnqcpxy",
        "start_date": "2022-08-04",
        "end_date": "2022-08-05",
        "start_half_day": true,
        "end_half_day": false,
        "start_time": "13:15:00",
        "end_time": "17:00:00",
        "amount": 2,
        "unit": "DAYS",
        "status": "APPROVED",
        "employee_note": "Visiting my family.",
        "type_id": "xzZoKssDaMZAd62kxayzzQvD",
        "remote_created_at": "2022-08-07T14:01:29.196Z",
        "remote_updated_at": "2022-08-07T14:01:29.196Z",
        "changed_at": "2022-08-07T14:01:29.196Z",
        "remote_deleted_at": "2022-08-07T14:01:29.196Z",
        "remote_data": null,
        "type": {
          "id": "xzZoKssDaMZAd62kxayzzQvD",
          "remote_id": "91",
          "name": "Vacation",
          "unit": "DAYS",
          "half_days_supported": true,
          "exact_times_supported": false,
          "remote_data": null,
          "custom_fields": {},
          "integration_fields": [],
          "changed_at": "2022-08-07T14:01:29.196Z",
          "remote_deleted_at": null
        }
      }
    ]
  }
}

Changes

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • breaking

      the // response's property type changed from no type to object for status

    • info

      added the new optional query request parameter ignore_unsupported_filters

    • info

      added the new optional query request parameter type_ids

    • info

      removed the pattern /^([\da-z]{24}(,[\da-z]{24})*)?$/i from the query request parameter ids

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property /// to the response with the status

    • info

      removed subschema #1 subschema #2 from the // response property allOf list for the response status

    • info

      the response property const value success was added for the status

    • info

      removed the success enum value from the response property for the response status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status