Skip to main content
GET
Get Time Off By Id

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token
string
required

Path Parameters

id
string<uuid>
required

Query Parameters

include_raw_data
boolean
default:false

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

Example:

false

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

expand
string

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

Response

Successful Response

The TimeOff object is used to represent all employees' Time Off entries.

id
string<uuid>
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

modified_at
string
required

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

Example:

"2021-10-16T00:00:00Z"

custom_fields
Custom Fields · object | null
required

The custom fields related to the model

Example:
employee
any | null
required

The employee requesting time off.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

approver
any | null
required

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

Example:

"018b4bfb-6065-7f83-b11d-e85ea49e37c3"

status
enum<string>
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.

Available options:
REQUESTED,
APPROVED,
DECLINED,
CANCELLED,
DELETED
Example:

"APPROVED"

employee_note
string | null
required

The employee note for this time off request.

Example:

"Paid paid vacation! Scuba diving in Hawaii."

units
enum<string>
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.

Available options:
HOURS,
DAYS
Example:

"HOURS"

amount
required

The time off quantity measured by the prescribed “units”.

Example:

12

request_type
enum<string>
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.

Available options:
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
Example:

"VACATION"

start_time
string | null
required

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

Example:

"2023-04-10T00:00:00Z"

raw_data
Raw Data · object | null

This is the Raw data

Example:
end_time
string | null
default:The day and time of the end of the time requested off.
Example:

"2023-04-10T00:00:00Z"