Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
Time Off

Get Time Off By Id

Returns a TimeOff object with the given id.

get/api/hris/v1/time-off/{id}

Path parameters

idstring uuid required

Query parameters

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.

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.

Headers

x-connector-tokenstring required

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring required

This is the datetime that this object was last updated by Bindbee

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

employeestring nullable required

The employee requesting time off.

approverstring nullable required

The Bindbee ID of the employee with the ability to approve the time off request.

status'REQUESTED' | 'APPROVED' | 'DECLINED' | 'CANCELLED' | 'DELETED' nullable required

The status of this time off request. If the value is not one of the defined enum values, the original value passed through will be returned.

employee_notestring nullable required

The employee note for this time off request.

units'HOURS' | 'DAYS' nullable required

The measurement that the third-party integration uses to count time requested. If the value is not one of the defined enum values, the original value passed through will be returned.

request_type'VACATION' | 'SICK' | 'PERSONAL' | 'JURY_DUTY' | 'VOLUNTEER' | 'BEREAVEMENT' | 'MATERNITY' | 'ANNUAL_LEAVE' | 'EMERGENCY_LEAVE' | 'LEAVE_OF_ABSENCE' | 'PATERNITY' | 'PAID_TIME_OFF' | 'LONG_TERM_DISABILITY' | 'SHORT_TERM_DISABILITY' | 'COMP_OFF' | 'WORK_FROM_HOME' | 'COMPASSIONATE' | 'TIME_OFF' | 'FMLA' nullable required

The type of time off request. If the value is not one of the defined enum values, the original value passed through will be returned.

start_timestring nullable required

The day and time of the start of the time requested off.

end_timestring nullable

Example response

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