/time-off/{id}

Returns a TimeOff object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
include_remote_databooleanOptional

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

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

show_enum_originsenumOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
employeestring or nullformat: "uuid"
The employee requesting time off.
approverstring or nullformat: "uuid"
The Merge ID of the employee with the ability to approve the time off request.
statusenum or null

The status of this time off request.

  • REQUESTED - REQUESTED
  • APPROVED - APPROVED
  • DECLINED - DECLINED
  • CANCELLED - CANCELLED
  • DELETED - DELETED
Allowed values:
employee_notestring or null
The employee note for this time off request.
unitsenum or null

The measurement that the third-party integration uses to count time requested.

  • HOURS - HOURS
  • DAYS - DAYS
Allowed values:
amountdouble or null

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

request_typeenum or null

The type of time off request.

  • VACATION - VACATION
  • SICK - SICK
  • PERSONAL - PERSONAL
  • JURY_DUTY - JURY_DUTY
  • VOLUNTEER - VOLUNTEER
  • BEREAVEMENT - BEREAVEMENT
start_timedatetime or null
The day and time of the start of the time requested off.
end_timedatetime or null
The day and time of the end of the time requested off.
remote_was_deletedbooleanRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullRead-only
remote_datalist of objects or nullRead-only

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information