Time Off

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

The TimeOff object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

employeeString
Optional
The employee requesting time off.

approverString
Optional
The Merge ID of the employee with the ability to approve the time off request.

statusEnum
Optional
The status of this time off request. Possible values include: REQUESTED, APPROVED, DECLINED, CANCELLED, DELETED, or - in cases where there is no clear mapping - the original value passed through.

employee_noteString
Optional
The employee note for this time off request.

unitsEnum
Optional
The measurement that the third-party integration uses to count time requested. Possible values include: HOURS, DAYS, or - in cases where there is no clear mapping - the original value passed through.

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

request_typeEnum
Optional
The type of time off request. Possible values include: VACATION, SICK, PERSONAL, JURY_DUTY, VOLUNTEER, BEREAVEMENT, or - in cases where there is no clear mapping - the original value passed through.

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

end_timeString
Optional
The day and time of the end of the time requested off.

remote_was_deletedBoolean
Required

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional

The TimeOff object
JSON
{
"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
}

GET

/time-off

Returns a list of TimeOff objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


approver_idString
Optional
If provided, will only return time off for this approver.

created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

employee_idString
Optional
If provided, will only return time off for this employee.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

remote_idString
Optional
The API provider's ID for the given object.

request_typeString
Optional
If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')

show_enum_originsString
Optional
Which fields should be returned in non-normalized form.

statusString
Optional
If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED')

Response
JSON
{
"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
}
]
}
Field support by platform

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

AlexisHR

AlexisHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_timeString

statusEnum

unitsEnum

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Breathe

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Ceridian Dayforce

Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Charlie

Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Factorial

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

statusEnum

unitsEnum

Hibob

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Humaans

Humaans

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Justworks

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Keka

Keka

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Lucca

Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Officient

Officient

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

PeopleHR

PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

request_typeEnum

start_timeString

statusEnum

unitsEnum

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employeeString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Sesame

Sesame

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

UKG Dimensions

UKG Dimensions

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


approverString

employeeString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_timeString

statusEnum

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

remote_dataRemoteData[]
pathstring
dataobject

request_typeEnum

start_timeString

statusEnum

unitsEnum

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum
Hint: Use the /linked-accounts endpoint to pull platform support information.
POST

/time-off

Creates a TimeOff object with the given values.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.

Body Parameters


modelObject
Required
Find available fields below under “Model Parameters”.

Model Parameters

View app-specific writable fields under “Field support by platform” in this section.

employeeString
The employee requesting time off. Must pass in a valid Merge ID, which can be obtained from the id field in the Employee table.

approverString
The Merge ID of the employee with the ability to approve the time off request. Must pass in a valid Merge ID, which can be obtained from the id field in the Employee table.

statusEnum
The status of this time off request. Must pass in one of the following choices: REQUESTED, APPROVED, DECLINED, CANCELLED, DELETED.

employee_noteString
The employee note for this time off request.

unitsEnum
The measurement that the third-party integration uses to count time requested. Must pass in one of the following choices: HOURS, DAYS.

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

request_typeEnum
The type of time off request. Must pass in one of the following choices: VACATION, SICK, PERSONAL, JURY_DUTY, VOLUNTEER, BEREAVEMENT.

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

end_timeString
The day and time of the end of the time requested off.

integration_paramsObject

linked_account_paramsObject

POST v1/time-off
JSON
{
"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"
}
}
Response
JSON
{
"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
}
}
Field support by platform

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


amountNumber
Optional

employeeString
Optional

employee_noteString
Optional

end_timeString
Optional

request_typeEnum
Optional

start_timeString
Optional

statusEnum
Optional

unitsEnum
Optional

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


amountNumber
Optional

employeeString
Required

employee_noteString
Optional

end_timeString
Optional

request_typeEnum
Optional

start_timeString
Optional

statusEnum
Optional

Ceridian Dayforce

Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


amountNumber
Optional

employeeString
Required

employee_noteString
Optional

end_timeString
Required

remote_idString
Optional

request_typeEnum
Required

start_timeString
Required

statusEnum
Optional

unitsEnum
Optional

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


amountNumber
Optional

approverString
Optional

employeeString
Optional

employee_noteString
Required

end_timeString
Required

remote_idString
Optional

request_typeEnum
Required

start_timeString
Required

statusEnum
Optional

unitsEnum
Optional

Humaans

Humaans

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


amountNumber
Optional

approverString
Optional

employeeString
Required

employee_noteString
Optional

end_timeString
Required

remote_idString
Optional

request_typeEnum
Required

start_timeString
Required

statusEnum
Optional

unitsEnum
Optional

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


employeeString
Required

employee_noteString
Optional

end_timeString
Required

remote_idString
Optional

request_typeEnum
Required

start_timeString
Required

statusEnum
Optional

unitsEnum
Optional

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


amountNumber
Optional

employeeString
Required

employee_noteString
Optional

end_timeString
Optional

remote_idString
Optional

request_typeEnum
Required

start_timeString
Optional

unitsEnum
Optional

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


amountNumber
Required

employeeString
Required

employee_noteString
Optional

remote_idString
Optional

request_typeEnum
Required

start_timeString
Required

statusEnum
Optional

unitsEnum
Optional
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/time-off/{id}

Returns a TimeOff object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

show_enum_originsString
Optional
Which fields should be returned in non-normalized form.

Response
JSON
{
"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
}
Field support by platform

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

AlexisHR

AlexisHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_timeString

statusEnum

unitsEnum

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Breathe

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Ceridian Dayforce

Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Charlie

Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Factorial

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

statusEnum

unitsEnum

Hibob

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Humaans

Humaans

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Justworks

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Keka

Keka

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Lucca

Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Officient

Officient

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

PeopleHR

PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

request_typeEnum

start_timeString

statusEnum

unitsEnum

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employeeString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Sesame

Sesame

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

UKG Dimensions

UKG Dimensions

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


approverString

employeeString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_timeString

statusEnum

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

remote_dataRemoteData[]
pathstring
dataobject

request_typeEnum

start_timeString

statusEnum

unitsEnum

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/time-off/meta/post

Returns metadata for TimeOff POSTs.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Response
JSON
{
"request_schema": {},
"remote_field_classes": {},
"status": {
"linked_account_status": "string",
"can_make_request": true
},
"has_conditional_params": true,
"has_required_linked_account_params": true
}
Field support by platform

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

AlexisHR

AlexisHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_timeString

statusEnum

unitsEnum

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Breathe

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Ceridian Dayforce

Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Charlie

Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Factorial

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

statusEnum

unitsEnum

Hibob

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Humaans

Humaans

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Justworks

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Keka

Keka

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Lucca

Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Officient

Officient

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

PeopleHR

PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

request_typeEnum

start_timeString

statusEnum

unitsEnum

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

approverString

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

employee_noteString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employeeString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Sesame

Sesame

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

employeeString

end_timeString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

request_typeEnum

start_timeString

statusEnum

unitsEnum