List Employee Time Off Requests

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>'

{
  "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.000",
      "end_date": "2021-01-01T01:01:01.000",
      "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_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",
          "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"
      },
      "comment": "Taking a day off for personal reasons"
    }
  ],
  "next_page": "<string>",
  "next": "<string>",
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

GET

unified

hris

employees

{id}

time_off

List Employee Time Off Requests

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>'

{
  "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.000",
      "end_date": "2021-01-01T01:01:01.000",
      "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_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",
          "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"
      },
      "comment": "Taking a day off for personal reasons"
    }
  ],
  "next_page": "<string>",
  "next": "<string>",
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "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

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

proxy

object

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

filter

object

HRIS Time Off filters

Show child attributes

filter[updated_after]

string<date-time> | null

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

Example:

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

filter[policy_ids]

string[] | null

List of time off policy ids to filter by.

filter[start_date]

string<date-time> | null

Filter to include time off requests that start on or after this date.

Example:

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

filter[end_date]

string<date-time> | null

Filter to include time off requests that end on or before this date.

Example:

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

page

string | null

The page number of the results to fetch

page_size

string | null

The number of results per page (default value is 25)

string | null

The unified cursor

updated_after

string<date-time> | null

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

Example:

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

expand

string | null

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

Example:

"policy"

Response

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

data

object[]

required

Show child attributes

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

Show child attributes

data.status.value

enum<string> | null

Available options:

approved,

cancelled,

rejected,

pending,

deleted,

draft,

unmapped_value,

data.status.source_value

data.type

object

deprecated

The type of the time off request

Show child attributes

data.type.value

enum<string> | null

Available options:

sick,

unmapped_value,

vacation,

long_term_disability,

short_term_disability,

absent,

comp_time,

training,

annual_leave,

leave_of_absence,

break,

child_care_leave,

maternity_leave,

jury_duty,

sabbatical,

accident,

paid,

unpaid,

holiday,

personal,

in_lieu,

bereavement,

other,

data.type.source_value

data.start_date

string<datetime-local> | null

The start date of the time off request (ISO8601 date-time without timezone)

Example:

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

data.end_date

string<datetime-local> | null

Inclusive end date of the time off request (ISO8601 date-time without timezone). The time off includes this day

Example:

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

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<duration> | 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

Show child attributes

data.reason.id

string | null

Unique identifier

Example:

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

data.reason.remote_id

string | null

Provider's unique identifier

Example:

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

data.reason.name

string | null

data.created_at

string<date-time> | null

Timestamp when the time off request was created

Example:

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

data.updated_at

string<date-time> | null

Timestamp when the time off request was last updated

Example:

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

data.policy

object

The time off policy associated with Time Off

Show child attributes

data.policy.id

string | null

Unique identifier

Example:

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

data.policy.remote_id

string | null

Provider's unique identifier

Example:

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

data.policy.name

string | null

The name of this policy

Example:

"Holidays"

data.policy.description

string | null

The description of this policy

Example:

"Usable for regional and national holidays of employees."

data.policy.type

object

The type of this policy

Show child attributes

data.policy.type.value

enum<string> | null

The unified value for the type of the time off policy. If the provider does not specify this unit, the value will be set to unmapped_value

Available options:

sick,

unmapped_value,

vacation,

long_term_disability,

short_term_disability,

absent,

comp_time,

training,

annual_leave,

leave_of_absence,

break,

child_care_leave,

maternity_leave,

jury_duty,

sabbatical,

accident,

paid,

unpaid,

holiday,

personal,

in_lieu,

bereavement,

other,

Example:

"holiday"

data.policy.type.source_value

data.policy.duration_unit

object

The duration unit of the current policy

Show child attributes

data.policy.duration_unit.value

enum<string> | null

The unified value for the duration unit. If the provider does not specify this unit, the value will be set to unknown

Available options:

minutes,

hours,

days,

weeks,

months,

years,

unknown,

unmapped_value,

Example:

"hours"

data.policy.duration_unit.source_value

data.policy.reasons

object[] | null

Show child attributes

data.policy.reasons.id

string | null

Unique identifier

Example:

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

data.policy.reasons.remote_id

string | null

Provider's unique identifier

Example:

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

data.policy.reasons.name

string | null

data.policy.created_at

string<date-time> | null

The created_at date of this policy

Example:

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

data.policy.updated_at

string<date-time> | null

The updated_at date of this policy

Example:

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

data.comment

string | null

Allows users to provide additional context or notes for their time off request

Example:

"Taking a day off for personal reasons"

next_page

string | null

deprecated

string | null

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

object

raw.response

Get Employee Shift Create Employee Time Off Request

⌘I

Getting Started

Use Cases

API Reference

List Employee Time Off Requests

Authorizations

Headers

Path Parameters

Query Parameters

Response