List Employee Time Off Requests

GET

unified

hris

employees

{id}

time_off

curl --request GET \
  --url https://api.stackone.com/unified/hris/employees/{id}/time_off \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "next_page": "<string>",
  "next": "<string>",
  "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"
    }
  ],
  "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

string

required

Query Parameters

raw

boolean | null

default:false

Indicates that the raw request result is returned

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"

filter

object | null

HRIS Time Off filters

page

string | null

deprecated

The page number of the results to fetch

page_size

string | null

default:25

The number of results per page

string | null

The unified cursor

updated_after

string | null

deprecated

Use a string with a date to only select results updated after that given date

Example:

"2020-01-01T00:00:00.000Z"

Response

200

application/json

The time off requests related to the employee with the given identifier were retrieved.

data

object[]

required

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.employee_id

string | null

The employee ID

Example:

"1687-3"

data.remote_employee_id

string | null

Provider's unique identifier of the employee

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.approver_id

string | null

The approver ID

Example:

"1687-4"

data.remote_approver_id

string | null

Provider's unique identifier of the approver

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.status

object

The status of the time off request

data.type

object

The type of the time off request

data.start_date

string | null

The start date of the time off request

Example:

"2021-01-01T01:01:01.000Z"

data.end_date

string | null

The end date of the time off request

Example:

"2021-01-01T01:01:01.000Z"

data.start_half_day

True if the start of the time off request begins half way through the day

Example:

true

data.end_half_day

True if the end of the time off request ends half way through the day

Example:

true

data.duration

string | null

The duration of the time off request

Example:

"P3Y6M4DT12H30M5S"

data.time_off_policy_id

string | null

The time off policy id associated with this time off request

Example:

"cx280928933"

data.remote_time_off_policy_id

string | null

Provider's unique identifier of the time off policy id associated with this time off request

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.reason

object

data.created_date

string | null

The created date of the time off request

Example:

"2021-01-01T01:01:01.000Z"

data.updated_date

string | null

The updated date of the time off request

Example:

"2021-01-01T01:01:01.000Z"

next_page

string | null

deprecated

string | null

raw

object[] | null

Was this page helpful?

Suggest edits

Get Employees Time Off Request Get Employee Time Off Balance

curl --request GET \
  --url https://api.stackone.com/unified/hris/employees/{id}/time_off \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "next_page": "<string>",
  "next": "<string>",
  "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"
    }
  ],
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

HRIS

Common Guides

API Reference

List Employee Time Off Requests

Authorizations

Headers

Path Parameters

Query Parameters

Response