v1

latestOpenAPI 3.1.02026-07-1274177461.2 KB

Employees

Time Off

Get Employees Time Off Request

get/unified/hris/employees/{id}/time_off/{subResourceId}

Path parameters

idstring required

subResourceIdstring required

Query parameters

rawboolean nullable

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxyobject nullable

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fieldsstring nullable

Example:id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

expandstring nullable

Example:policy

The comma separated list of fields that will be expanded in the response

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Response

The time off request related to the employee with the given identifiers was retrieved.

Example response

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "employee_id": "1687-3",
    "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "approver_id": "1687-4",
    "remote_approver_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "start_date": "2021-01-01T01:01:01.000",
    "end_date": "2021-01-01T01:01:01.000",
    "duration": "P3Y6M4DT12H30M5S",
    "time_off_policy_id": "cx280928933",
    "remote_time_off_policy_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "reason": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
    },
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z",
    "policy": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Holidays",
      "description": "Usable for regional and national holidays of employees.",
      "type": {
        "value": "holiday"
      },
      "duration_unit": {
        "value": "hours"
      },
      "reasons": [
        {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
        }
      ],
      "created_at": "2021-01-01T01:01:01.000Z",
      "updated_at": "2021-01-01T01:01:01.000Z"
    },
    "comment": "Taking a day off for personal reasons"
  }
}