BIbindbee
Time Off

Get Time Off List

Changed on

Returns a list of TimeOff objects.

get/api/hris/v1/time-off

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Query parameters

idsstring nullable

The ID of the time offs to fetch

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

The third-party API ID of the matching object.

Example:3235005483341316245
employee_idstring nullable

The ID of the employees to fetch time offs for

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

The status of the time off to filter by. Pass several values, comma-separated, to match any of them.

Example:REQUESTED
include_raw_databoolean

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.

page_sizeinteger

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

cursorstring nullable

The pagination cursor value.

expandstring nullable

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. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]
modified_afterstring nullable

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

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

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

The page size the request was served with (0 on an empty page). items can be shorter on the last page; cursor says whether another page exists.

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"
    }
  ]
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the ANNUAL_LEAVE enum value from the // response property for the response status

    • info

      removed the APPROVED enum value from the // response property for the response status

    • info

      removed the BEREAVEMENT enum value from the // response property for the response status

    • info

      removed the CANCELLED enum value from the // response property for the response status

    • info

      removed the COMPASSIONATE enum value from the // response property for the response status

    • info

      removed the COMP_OFF enum value from the // response property for the response status

    • info

      removed the DAYS enum value from the // response property for the response status

    • info

      removed the DECLINED enum value from the // response property for the response status

    • info

      removed the DELETED enum value from the // response property for the response status

    • info

      removed the EMERGENCY_LEAVE enum value from the // response property for the response status

    • info

      removed the FMLA enum value from the // response property for the response status

    • info

      removed the HOURS enum value from the // response property for the response status

    • info

      removed the JURY_DUTY enum value from the // response property for the response status

    • info

      removed the LEAVE_OF_ABSENCE enum value from the // response property for the response status

    • info

      removed the LONG_TERM_DISABILITY enum value from the // response property for the response status

    • info

      removed the MATERNITY enum value from the // response property for the response status

    • info

      removed the PAID_TIME_OFF enum value from the // response property for the response status

    • info

      removed the PATERNITY enum value from the // response property for the response status

    • info

      removed the PERSONAL enum value from the // response property for the response status

    • info

      removed the REQUESTED enum value from the // response property for the response status

    • info

      removed the SHORT_TERM_DISABILITY enum value from the // response property for the response status

    • info

      removed the SICK enum value from the // response property for the response status

    • info

      removed the TIME_OFF enum value from the // response property for the response status

    • info

      removed the VACATION enum value from the // response property for the response status

    • info

      removed the VOLUNTEER enum value from the // response property for the response status

    • info

      removed the WORK_FROM_HOME enum value from the // response property for the response status

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API