Get Request

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

{
  "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>"
}

GET

time-off

requests

{requestId}

Get Request

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

{
  "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>"
}

Get a specific time off request

Authorizations

Authorization

string

header

required

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

Path Parameters

requestId

string<uuid>

required

Query Parameters

expand

string

Available expansions: policy, provider, rejectedBy

See Query Parameters for more information on expansions.

Response

string<uuid>

required

createdAt

string

required

Example:

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

status

enum<string>

required

Available options:

pending,

approved,

rejected,

cancelled

Example:

"approved"

startDate

string

required

Example:

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

endDate

string

required

Example:

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

policyId

string<uuid>

required

providerId

string<uuid>

required

note

string | null

required

Example:

"Going on vacation with my family."

dailyHours

object[]

required

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

Show child attributes

dailyHours.date

string

required

ISO timestamp of the date for the daily hours.

Example:

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

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
  }
]

paidHours

number

required

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

Example:

32

policy

object

Show child attributes

policy.id

string<uuid>

required

policy.createdAt

string

required

Example:

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

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"

policy.name

string

required

Example:

"QC Vacation"

policy.description

string | null

required

Example:

"Vacation policy for Quebec-based employees."

policy.accrualUnit

enum<string>

required

Available options:

hours,

days

policy.payCodeId

string<uuid> | null

required

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

policy.properties

any

policy.payCode

object

Show child attributes

policy.payCode.id

string<uuid>

required

policy.payCode.name

string

required

Example:

"Overtime"

policy.payCode.shorthandName

string

required

Example:

"OT"

policy.payCode.hexColor

string

required

Example:

"#f97316"

policy.payCode.type

enum<string>

required

Available options:

hours,

days,

money

policy.payCode.value

number

required

Example:

1.5

provider

object

Show child attributes

provider.id

string<uuid>

required

provider.name

string | null

required

Example:

"Bruce Wayne"

provider.email

string

required

Example:

"[email protected]"

provider.hireDate

string | null

required

Example:

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

provider.status

enum<string>

required

Available options:

onboarding,

active,

dismissed,

inactive

Example:

"active"

provider.teamId

string<uuid> | null

required

provider.licensedRegions

string[]

required

provider.employmentType

string<uuid> | null

required

rejectedById

string<uuid>

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

rejectedBy

object

Show child attributes

rejectedBy.id

string<uuid>

required

rejectedBy.type

enum<string>

required

Available options:

user,

bot

rejectedBy.name

string

required

rejectedBy.email

string

required

rejectedBy.status

enum<string>

required

Available options:

onboarding,

active,

dismissed,

inactive

rejectionReason

string | null

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

Get Requests Get Timesheets

⌘I

V1

Authorizations

Path Parameters

Query Parameters

Response