GET
/
unified
/
hris
/
time_off_policies
curl --request GET \
  --url https://api.stackone.com/unified/hris/time_off_policies \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'
{
  "next": "<string>",
  "data": [
    {
      "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": "holiday",
      "duration_unit": "hours",
      "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

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,name,description,type,duration_unit,reasons,updated_at,created_at"

​
filter
object | null

Filter parameters that allow greater customisation of the list response

​
page
string | null
deprecated

The page number of the results to fetch

​
page_size
string | null
default:25

The number of results per page

​
next
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 list of time off policies was retrieved.
​
data
object[]
required
​
next
string | null
​
raw
object[] | null

Was this page helpful?

Suggest edits
Get Time Off Policy