For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The TimeOff object
          • GET/time-off
          • POST/time-off
          • GET/time-off/{id}
          • GET/time-off/meta/post
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsTime off

/time-off

GET
/hris/v1/time-off
GET
/api/hris/v1/time-off
$curl -G https://api.merge.dev/api/hris/v1/time-off \
>     -H "X-Account-Token: X-Account-Token" \
>     -H "Authorization: Bearer <token>" \
>     -d approver_id=approver_id \
>     -d cursor=cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw \
>     -d employee_id=employee_id \
>     --data-urlencode expand=employee,approver \
>     --data-urlencode remote_fields=request_type,status,units \
>     --data-urlencode show_enum_origins=request_type,status,units
200Retrieved
1{
2  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
3  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
4  "results": [
5    {
6      "id": "91b2b905-e866-40c8-8be2-efe53827a0aa",
7      "remote_id": "19202938",
8      "created_at": "2021-09-15T00:00:00Z",
9      "modified_at": "2021-10-16T00:00:00Z",
10      "employee": "d2f972d0-2526-434b-9409-4c3b468e08f0",
11      "approver": "9efbc633-3387-4306-aa55-e2c635e6bb4f",
12      "status": "APPROVED",
13      "employee_note": "Moving into the new apartment Kendall Roy gave me!",
14      "units": "DAYS",
15      "amount": 3,
16      "request_type": "VACATION",
17      "start_time": "2020-11-10T00:00:00Z",
18      "end_time": "2020-11-17T00:00:00Z",
19      "remote_was_deleted": true,
20      "field_mappings": {
21        "organization_defined_targets": {
22          "custom_key": "custom_value"
23        },
24        "linked_account_defined_targets": {
25          "custom_key": "custom_value"
26        }
27      },
28      "remote_data": [
29        {
30          "path": "/leave",
31          "data": null
32        }
33      ]
34    }
35  ]
36}

Returns a list of TimeOff objects.

Field support by integration

See all supported fields

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

Was this page helpful?
Previous

The TimeOff object

Next

/time-off

Built with

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

approver_idstringOptional
If provided, will only return time off for this approver.
created_afterdatetimeOptional
If provided, will only return objects created after this datetime.
created_beforedatetimeOptional
If provided, will only return objects created before this datetime.
cursorstringOptional
The pagination cursor value.
employee_idstringOptional
If provided, will only return time off for this employee.
ended_afterdatetimeOptional
If provided, will only return employees that ended after this datetime.
ended_beforedatetimeOptional

If provided, will only return time-offs that ended before this datetime.

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
include_deleted_databooleanOptional
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](https://docs.merge.dev/integrations/hris/supported-features/).
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).

modified_afterdatetimeOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforedatetimeOptional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeintegerOptional
Number of results to return per page. The maximum limit is 100.
remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

remote_idstringOptional
The API provider's ID for the given object.
request_typeenumOptional
If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
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)
started_afterdatetimeOptional

If provided, will only return time-offs that started after this datetime.

started_beforedatetimeOptional

If provided, will only return time-offs that started before this datetime.

statusenumOptional
If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED
Allowed values:

Response

nextstring or null
previousstring or null
resultslist of objects

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.

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

  • VACATION - VACATION
  • SICK - SICK
  • PERSONAL - PERSONAL
  • JURY_DUTY - JURY_DUTY
  • VOLUNTEER - VOLUNTEER
  • BEREAVEMENT - BEREAVEMENT

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

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

  • REQUESTED - REQUESTED
  • APPROVED - APPROVED
  • DECLINED - DECLINED
  • CANCELLED - CANCELLED
  • DELETED - DELETED