Skip to main content
GET
/
v1
/
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.",
    "payCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "properties": "<unknown>",
    "payCode": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Overtime",
      "shorthandName": "OT",
      "hexColor": "#f97316",
      "value": 1.5
    }
  },
  "provider": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Bruce Wayne",
    "email": "bruce.wayne@goodhealth.com",
    "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",
    "name": "<string>",
    "email": "<string>",
    "isAdmin": true
  },
  "rejectionReason": "<string>",
  "syncError": {
    "message": "<string>",
    "createdAt": "2024-11-20T07:43:34+0000"
  }
}
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

​
id
string<uuid>
required
​
createdAt
string
required
Example:

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

​
status
enum<string>
required
Available options:
pending,
approved,
rejected,
cancelled,
pending_sync,
sync_failed
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.

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
​
provider
object
​
rejectedById
string<uuid>

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

​
rejectedBy
object
​
rejectionReason
string | null

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

​
syncError
object

Present for pending_sync requests, contains the latest Rippling sync status and error message.

​
conflictResolution
enum<string> | null

The shift conflict resolution strategy selected when this request was approved.

Available options:
delete,
deleteWithOpen,
callout,
calloutWithOpen,
keep,
keepWithOpen,
null