Get Requests

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

get/v1/time-off/requests

Request

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

Query parameters

providerIdstring uuid

Filter to requests for a specific provider.

string uuid
OR
string[]
string uuid
OR
string[]
startDatestring

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

Example:2024-11-20T07:43:34+0000
endDatestring

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

Example:2024-11-20T07:43:34+0000
status'pending' | 'approved' | 'rejected' | 'cancelled' | 'pending_sync' | 'sync_failed'
Example:approved
querystring
expandstring

Available expansions: policy, provider, rejectedBy

See Query Parameters for more information on expansions.

sortstring

Available fields: createdAt, startDate

See Query Parameters for more information on sorting.

pageSizenumber
cursorstring

Response

cursorstring

Example response

{
  "items": [
    {
      "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.