/time-off/{id}

GET

/hris/v1/time-off/:id

GET

/api/hris/v1/time-off/:id

curl -G https://api.merge.dev/api/hris/v1/time-off/id \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -d include_remote_data=true

200Retrieved

{
  "id": "91b2b905-e866-40c8-8be2-efe53827a0aa",
  "remote_id": "19202938",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "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,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  },
  "remote_data": [
    {
      "path": "/leave",
      "data": null
    }
  ]
}

Returns a TimeOff object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandlist of enumsOptional

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

Response

idstringOptionalRead-onlyformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only

The datetime that this object was created by Merge.

modified_atdatetimeOptionalRead-only

The datetime that this object was modified by Merge.

employeestring or nullOptionalformat: "uuid"

The employee requesting time off.

approverstring or nullOptionalformat: "uuid"

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

statusenum or nullOptional

The status of this time off request. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=status to receive the integration’s own value instead.

Allowed values:

employee_notestring or nullOptional

The employee note for this time off request.

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=units to receive the integration’s own value instead.

Allowed values:

amountdouble or nullOptional

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

request_typeenum or nullOptional

The type of time off request. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=request_type to receive the integration’s own value instead.

start_timedatetime or nullOptional

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

end_timedatetime or nullOptional

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

remote_was_deletedbooleanOptionalRead-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 nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only

/time-off/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration