UNuntetherlabs

Get Request

Get a specific time off request

get/v1/time-off/requests/{requestId}

Request

  • Base URL
    https://app.untetherlabs.com/api
  • URL
    https://app.untetherlabs.com/api/v1/time-off/requests/{requestId}
  • Auth
    HTTP bearer

Path parameters

requestIdstring uuid required

Query parameters

expandstring

Available expansions: policy, provider, rejectedBy

See Query Parameters for more information on expansions.

Response

idstring uuid required
createdAtstring required
status'pending' | 'approved' | 'rejected' | 'cancelled' | 'pending_sync' | 'sync_failed' required
startDatestring required
endDatestring required
policyIdstring uuid required
providerIdstring uuid required
notestring nullable required
paidHoursnumber required

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

rejectedByIdstring uuid

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

rejectionReasonstring nullable

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

conflictResolution'delete' | 'deleteWithOpen' | 'callout' | 'calloutWithOpen' | 'keep' | 'keepWithOpen' | 'null' nullable

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

isFullDayboolean nullable

Whether the request blocks whole calendar days rather than the dailyHours windows. Null for requests created before this field existed; treated as full-day when the policy accrues in days.

Example response

{
  "createdAt": "2024-11-20T07:43:34+0000",
  "status": "approved",
  "startDate": "2024-11-20T07:43:34+0000",
  "endDate": "2024-11-20T07:43:34+0000",
  "policy": {
    "createdAt": "2024-11-20T07:43:34+0000",
    "type": "vacation",
    "name": "QC Vacation",
    "description": "Vacation policy for Quebec-based employees.",
    "payCode": {
      "name": "Overtime",
      "shorthandName": "OT",
      "hexColor": "#f97316",
      "value": 1.5
    }
  },
  "provider": {
    "name": "Bruce Wayne",
    "email": "bruce.wayne@goodhealth.com",
    "hireDate": "2024-11-20T07:43:34+0000",
    "jobTitle": "Registered Nurse",
    "status": "active"
  },
  "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,
  "syncError": {
    "createdAt": "2024-11-20T07:43:34+0000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.