GET
/
unified
/
hris
/
time_off
/
{id}
curl --request GET \
  --url https://api.stackone.com/unified/hris/time_off/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'
{
  "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",
    "status": {
      "value": "approved",
      "source_value": "<string>"
    },
    "type": {
      "value": "sick",
      "source_value": "<string>"
    },
    "start_date": "2021-01-01T01:01:01.000Z",
    "end_date": "2021-01-01T01:01:01.000Z",
    "start_half_day": true,
    "end_half_day": true,
    "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",
      "name": "<string>"
    },
    "created_date": "2021-01-01T01:01:01.000Z",
    "updated_date": "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",
        "source_value": "<string>"
      },
      "duration_unit": {
        "value": "hours",
        "source_value": "<string>"
      },
      "reasons": [
        {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "name": "<string>"
        }
      ],
      "created_at": "2021-01-01T01:01:01.000Z",
      "updated_at": "2021-01-01T01:01:01.000Z"
    }
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

Path Parameters

​
id
string
required

Query Parameters

​
raw
boolean | null

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

​
proxy
object | null

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

​
fields
string | null

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

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,duration,time_off_policy_id,remote_time_off_policy_id,reason,created_at,updated_at,policy"

​
expand
string | null

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

Example:

"policy"

Response

200
application/json
The time off request with the given identifier was retrieved.
​
data
object
required
​
raw
object[] | null

Was this page helpful?

Raise issue