TimeOff
object is used to represent all employees' Time Off entries.id
Stringremote_id
Stringemployee
Stringapprover
Stringstatus
EnumREQUESTED
, APPROVED
, DECLINED
, CANCELLED
, DELETED
, or -
in cases where there is no clear mapping - the original value passed through.employee_note
Stringunits
EnumHOURS
, DAYS
, or -
in cases where there is no clear mapping - the original value passed through.amount
Numberrequest_type
EnumVACATION
, SICK
, PERSONAL
, JURY_DUTY
, VOLUNTEER
, BEREAVEMENT
, or -
in cases where there is no clear mapping - the original value passed through.start_time
Stringend_time
Stringremote_was_deleted
Booleanfield_mappings
Objectmodified_at
Stringremote_data
RemoteData[]{"id": "91b2b905-e866-40c8-8be2-efe53827a0aa","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","approver": "9efbc633-3387-4306-aa55-e2c635e6bb4f","status": "APPROVED","employee_note": "Moving into the new apartment Kendall Roy gave me!","units": "DAYS","amount": 3,"request_type": "VACATION","start_time": "2020-11-10T00:00:00Z","end_time": "2020-11-17T00:00:00Z","remote_was_deleted": true,Show advanced fields}
Returns a list of TimeOff
objects.
Authorization
StringX-Account-Token
Stringapprover_id
Stringcreated_after
Stringcreated_before
Stringcursor
Stringemployee_id
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_fields
Stringremote_id
Stringrequest_type
Stringshow_enum_origins
Stringstatus
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "91b2b905-e866-40c8-8be2-efe53827a0aa","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","approver": "9efbc633-3387-4306-aa55-e2c635e6bb4f","status": "APPROVED","employee_note": "Moving into the new apartment Kendall Roy gave me!","units": "DAYS","amount": 3,"request_type": "VACATION","start_time": "2020-11-10T00:00:00Z","end_time": "2020-11-17T00:00:00Z","remote_was_deleted": true,Show advanced fields}]}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
employee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
employee
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
approver
Stringemployee
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_time
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringremote_data
RemoteData[]path
stringdata
objectrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
EnumCreates a TimeOff
object with the given values.
Authorization
StringX-Account-Token
Stringis_debug_mode
Booleanrun_async
Booleanmodel
Objectemployee
Stringid
field in the Employee object.approver
Stringid
field in the Employee object.status
EnumREQUESTED
, APPROVED
, DECLINED
, CANCELLED
, DELETED
.employee_note
Stringunits
EnumHOURS
, DAYS
.amount
Numberrequest_type
EnumVACATION
, SICK
, PERSONAL
, JURY_DUTY
, VOLUNTEER
, BEREAVEMENT
.start_time
Stringend_time
Stringintegration_params
Objectlinked_account_params
Object{"model": {"employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","approver": "9efbc633-3387-4306-aa55-e2c635e6bb4f","status": "APPROVED","employee_note": "Moving into the new apartment Kendall Roy gave me!","units": "DAYS","amount": 3,"request_type": "VACATION","start_time": "2020-11-10T00:00:00Z","end_time": "2020-11-17T00:00:00Z"}}
{"model": {"id": "91b2b905-e866-40c8-8be2-efe53827a0aa","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","approver": "9efbc633-3387-4306-aa55-e2c635e6bb4f","status": "APPROVED","employee_note": "Moving into the new apartment Kendall Roy gave me!","units": "DAYS","amount": 3,"request_type": "VACATION","start_time": "2020-11-10T00:00:00Z","end_time": "2020-11-17T00:00:00Z","remote_was_deleted": true,Show advanced fields}}

Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringrequest_type
Enumstart_time
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
employee
Stringemployee_note
Stringend_time
Stringremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_id
Stringrequest_type
Enumstart_time
Stringunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
amount
Numberemployee
Stringemployee_note
Stringremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
EnumReturns a TimeOff
object with the given id
.
Authorization
StringX-Account-Token
Stringexpand
Stringid
Stringinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
String{"id": "91b2b905-e866-40c8-8be2-efe53827a0aa","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","approver": "9efbc633-3387-4306-aa55-e2c635e6bb4f","status": "APPROVED","employee_note": "Moving into the new apartment Kendall Roy gave me!","units": "DAYS","amount": 3,"request_type": "VACATION","start_time": "2020-11-10T00:00:00Z","end_time": "2020-11-17T00:00:00Z","remote_was_deleted": true,Show advanced fields}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
employee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
employee
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
approver
Stringemployee
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_time
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringremote_data
RemoteData[]path
stringdata
objectrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
EnumReturns metadata for TimeOff
POSTs.
Authorization
StringX-Account-Token
String{"request_schema": {},"remote_field_classes": {},"status": {"linked_account_status": "string","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
employee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberapprover
Stringemployee
Stringemployee_note
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrequest_type
Enumstart_time
Stringstatus
Enumunits
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
amount
Numberemployee
Stringend_time
Stringremote_data
RemoteData[]path
stringdata
objectremote_id