Get Requests

curl --request GET \
  --url https://app.untetherlabs.com/api/v1/time-off/requests \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2024-11-20T07:43:34+0000",
      "status": "approved",
      "startDate": "2024-11-20T07:43:34+0000",
      "endDate": "2024-11-20T07:43:34+0000",
      "policyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "note": "Going on vacation with my family.",
      "dailyHours": [
        {
          "date": "2024-10-06T00:00:00.000Z",
          "duration": 0
        },
        {
          "date": "2024-10-07T00:00:00.000Z",
          "duration": 8
        },
        {
          "date": "2024-10-08T00:00:00.000Z",
          "duration": 8
        }
      ],
      "paidHours": 32,
      "policy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2024-11-20T07:43:34+0000",
        "type": "vacation",
        "name": "QC Vacation",
        "description": "Vacation policy for Quebec-based employees.",
        "accrualUnit": "hours",
        "payCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "properties": "<unknown>",
        "payCode": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "Overtime",
          "shorthandName": "OT",
          "hexColor": "#f97316",
          "type": "hours",
          "value": 1.5
        }
      },
      "provider": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Bruce Wayne",
        "email": "[email protected]",
        "hireDate": "2024-11-20T07:43:34+0000",
        "status": "active",
        "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "licensedRegions": [
          "<string>"
        ],
        "employmentType": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "rejectedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rejectedBy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "user",
        "name": "<string>",
        "email": "<string>",
        "status": "onboarding"
      },
      "rejectionReason": "<string>"
    }
  ],
  "cursor": "<string>"
}

GET

time-off

requests

Get Requests

curl --request GET \
  --url https://app.untetherlabs.com/api/v1/time-off/requests \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2024-11-20T07:43:34+0000",
      "status": "approved",
      "startDate": "2024-11-20T07:43:34+0000",
      "endDate": "2024-11-20T07:43:34+0000",
      "policyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "note": "Going on vacation with my family.",
      "dailyHours": [
        {
          "date": "2024-10-06T00:00:00.000Z",
          "duration": 0
        },
        {
          "date": "2024-10-07T00:00:00.000Z",
          "duration": 8
        },
        {
          "date": "2024-10-08T00:00:00.000Z",
          "duration": 8
        }
      ],
      "paidHours": 32,
      "policy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2024-11-20T07:43:34+0000",
        "type": "vacation",
        "name": "QC Vacation",
        "description": "Vacation policy for Quebec-based employees.",
        "accrualUnit": "hours",
        "payCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "properties": "<unknown>",
        "payCode": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "Overtime",
          "shorthandName": "OT",
          "hexColor": "#f97316",
          "type": "hours",
          "value": 1.5
        }
      },
      "provider": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Bruce Wayne",
        "email": "[email protected]",
        "hireDate": "2024-11-20T07:43:34+0000",
        "status": "active",
        "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "licensedRegions": [
          "<string>"
        ],
        "employmentType": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "rejectedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rejectedBy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "user",
        "name": "<string>",
        "email": "<string>",
        "status": "onboarding"
      },
      "rejectionReason": "<string>"
    }
  ],
  "cursor": "<string>"
}

Get all time off requests. Can be filtered if necessary.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

providerId

string<uuid>

Filter to requests for a specific provider.

teamId

string<uuid>[]

Filter to requests for providers in specific teams.

policyId

string<uuid>[]

Filter to requests for specific policies.

startDate

string

Filter to requests whose start date is on or after the given timestamp.

Example:

"2024-11-20T07:43:34+0000"

endDate

string

Filter to requests whose end date is earlier than the provided timestamp.

Example:

"2024-11-20T07:43:34+0000"

status

enum<string>

Available options:

pending,

approved,

rejected,

cancelled

Example:

"approved"

query

string

expand

string

Available expansions: policy, provider, rejectedBy

See Query Parameters for more information on expansions.

sort

string

Available fields: createdAt, startDate

See Query Parameters for more information on sorting.

pageSize

number

default:20

Required range: 1 <= x <= 200

cursor

string

Response

items

object[]

required

Show child attributes

items.id

string<uuid>

required

items.createdAt

string

required

Example:

"2024-11-20T07:43:34+0000"

items.status

enum<string>

required

Available options:

pending,

approved,

rejected,

cancelled

Example:

"approved"

items.startDate

string

required

Example:

"2024-11-20T07:43:34+0000"

items.endDate

string

required

Example:

"2024-11-20T07:43:34+0000"

items.policyId

string<uuid>

required

items.providerId

string<uuid>

required

items.note

string | null

required

Example:

"Going on vacation with my family."

items.dailyHours

object[]

required

Represents the number of hours requested off for each day in the time off request.

Show child attributes

items.dailyHours.date

string

required

ISO timestamp of the date for the daily hours.

Example:

"2024-10-06T00:00:00.000Z"

items.dailyHours.duration

number

required

Number of hours requested off for this day.

Example:

8

Example:

[
  {
    "date": "2024-10-06T00:00:00.000Z",
    "duration": 0
  },
  {
    "date": "2024-10-07T00:00:00.000Z",
    "duration": 8
  },
  {
    "date": "2024-10-08T00:00:00.000Z",
    "duration": 8
  }
]

items.paidHours

number

required

The total number of hours that will be paid out for this time off request.

Example:

32

items.policy

object

Show child attributes

items.policy.id

string<uuid>

required

items.policy.createdAt

string

required

Example:

"2024-11-20T07:43:34+0000"

items.policy.type

enum<string>

required

Available options:

bereavement,

floating-holiday,

holiday-pay,

jury-duty,

learning-and-development,

paid-time-off,

vacation,

parental-leave,

personal-day,

sick,

volunteer,

weather,

wellness,

flex-day,

marriage-code,

unpaid-day,

absence,

custom

Example:

"vacation"

items.policy.name

string

required

Example:

"QC Vacation"

items.policy.description

string | null

required

Example:

"Vacation policy for Quebec-based employees."

items.policy.accrualUnit

enum<string>

required

Available options:

hours,

days

items.policy.payCodeId

string<uuid> | null

required

The pay code for which associated time will be paid out.

items.policy.properties

any

items.policy.payCode

object

Show child attributes

items.policy.payCode.id

string<uuid>

required

items.policy.payCode.name

string

required

Example:

"Overtime"

items.policy.payCode.shorthandName

string

required

Example:

"OT"

items.policy.payCode.hexColor

string

required

Example:

"#f97316"

items.policy.payCode.type

enum<string>

required

Available options:

hours,

days,

money

items.policy.payCode.value

number

required

Example:

1.5

items.provider

object

Show child attributes

items.provider.id

string<uuid>

required

items.provider.name

string | null

required

Example:

"Bruce Wayne"

items.provider.email

string

required

Example:

"[email protected]"

items.provider.hireDate

string | null

required

Example:

"2024-11-20T07:43:34+0000"

items.provider.status

enum<string>

required

Available options:

onboarding,

active,

dismissed,

inactive

Example:

"active"

items.provider.teamId

string<uuid> | null

required

items.provider.licensedRegions

string[]

required

items.provider.employmentType

string<uuid> | null

required

items.rejectedById

string<uuid>

Only present for rejected time off requests, the user who rejected the request.

items.rejectedBy

object

Show child attributes

items.rejectedBy.id

string<uuid>

required

items.rejectedBy.type

enum<string>

required

Available options:

user,

bot

items.rejectedBy.name

string

required

items.rejectedBy.email

string

required

items.rejectedBy.status

enum<string>

required

Available options:

onboarding,

active,

dismissed,

inactive

items.rejectionReason

string | null

Only present for rejected time off requests, reason may be null for unspecified.

cursor

string

Get Policy Get Request

⌘I

V1

Authorizations

Query Parameters

Response