Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
Time Off

Get Time Off List

Returns a list of TimeOff objects.

get/api/hris/v1/time-off

Query parameters

idsstring nullable

The ID of the time offs to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

The ID of the time offs to fetch

remote_idstring

The third-party API ID of the matching object.

Example:3235005483341316245

The third-party API ID of the matching object.

employee_idstring nullable

The ID of the employees to fetch time offs for

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

The ID of the employees to fetch time offs for

statusstring nullable

The status of the time off to filter by

Example:REQUESTED

The status of the time off to filter by

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

Whether to include custom fields in the response.

page_sizeinteger

Number of results to return per page. Maximum size is 200.

Number of results to return per page. Maximum size is 200.

cursorstring

The pagination cursor value.

The pagination cursor value.

expandstring

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:manager[first_name,last_name]

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

modified_afterstring

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)

Example:2024-02-21T21:22:12.993Z

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)

Headers

x-connector-tokenstring required

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

Indicates the count of items in the response

Example response

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "remote_id": "123321",
      "modified_at": "2021-10-16T00:00:00Z",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "custom_fields": {
        "category_group": "REG",
        "disability_type": "ASBERG",
        "hire_date": "1991-03-16T00:00:00",
        "hire_source": "REFER",
        "nationality": "USA",
        "original_hire_date": "1991-03-16T00:00:00"
      },
      "employee": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
      "approver": "018b4bfb-6065-7f83-b11d-e85ea49e37c3",
      "status": "APPROVED",
      "employee_note": "Paid paid vacation! Scuba diving in Hawaii.",
      "units": "HOURS",
      "request_type": "VACATION",
      "start_time": "2023-04-10T00:00:00Z",
      "end_time": "2023-04-10T00:00:00Z"
    }
  ]
}