Q2 2025 Roadmap: Request a beta API key and access upcoming features: Embedded Notifications, Team Communications and more.

List Time-Offs

GET

/api/organizations/{organization_id}/time-off-requests/time-offs

Fetches all approved time-off periods across the organization.
POST /api/organizations/{organization_id}/time-off-requests

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/organizations//time-off-requests/time-offs?workerId&startTime&endTime'

Response Example

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "locationId": "123e4567-e89b-12d3-a456-426614174000",
    "workerId": "123e4567-e89b-12d3-a456-426614174000",
    "policyId": "123e4567-e89b-12d3-a456-426614174000",
    "policy": {
      "id": "string",
      "name": "string",
      "organizationId": "string",
      "allowNegativeBalance": true,
      "assignedStaffCount": 0,
      "carryover": true,
      "default": true,
      "fullDayDuration": 0,
      "limitSettings": "string",
      "paid": true,
      "requiresApproval": true,
      "status": "Draft",
      "type": {
        "id": "string",
        "name": "string",
        "type": "Sick"
      },
      "typeId": "string",
      "units": "days",
      "createdAt": "string",
      "updatedAt": "string"
    },
    "startTime": "2021-01-01T00:00:00.000Z",
    "endTime": "2021-01-01T00:00:00.000Z",
    "status": "pending",
    "note": "I need to take time off",
    "hourConfiguration": [
      {
        "date": "2021-01-01",
        "hours": 8
      },
      {
        "date": "2021-01-02",
        "hours": 4
      }
    ],
    "timezone": "America/New_York",
    "utcOffset": 240,
    "isAllDay": false,
    "submittedAt": "2021-01-01T00:00:00.000Z",
    "remainingBalance": 10,
    "totalHours": 10,
    "workerPolicy": {
      "id": "string",
      "name": "Policy 1",
      "hoursBalance": 0,
      "isIncluded": true,
      "availableBalance": 0
    }
  }
]

Request

Path Params

organization_id

string

required

Query Params

workerId

string

optional

The worker id

Example:

startTime

string

optional

Filter by start time

Example:

2021-01-01T12:30:00.000Z

endTime

string

optional

Filter by end time

Example:

2021-01-01T16:30:00.000Z

Responses

🟢200OK

application/json

Get all time off requests

Body

array of:

string

required

The id of the time off request

Example:

123e4567-e89b-12d3-a456-426614174000

locationId

string

required

The id of the location

Example:

123e4567-e89b-12d3-a456-426614174000

workerId

string

required

The id of the worker

Example:

123e4567-e89b-12d3-a456-426614174000

policyId

string

required

The id of the policy

Example:

123e4567-e89b-12d3-a456-426614174000

policy

object

optional

The policy of the time off request

Example:

{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Policy 1"}

string

required

organizationId

string

required

name

string

required

allowNegativeBalance

boolean

required

assignedStaffCount

number

required

carryover

boolean

required

default

boolean

required

fullDayDuration

number

required

limitSettings

string | null

required

paid

boolean

required

requiresApproval

boolean

required

status

enum<string>

required

Allowed values:

DraftActiveInactiveArchived

type

object

PolicyTypeDto

required

typeId

string

required

units

enum<string>

required

Allowed values:

dayshours

createdAt

string

required

updatedAt

string

required

startTime

string

required

The start time of the time off request

Example:

2021-01-01T00:00:00.000Z

endTime

string

required

The end time of the time off request

Example:

2021-01-01T00:00:00.000Z

status

enum<string>

required

The status of the time off request

Allowed values:

pendingapproveddeclined

Example:

pending

note

string | null

optional

The note of the time off request

Example:

I need to take time off

hourConfiguration

array[object (HourConfigurationItemDto) {2}]

required

Hour configuration for each day of the time off request

Example:

[{"date":"2021-01-01","hours":8},{"date":"2021-01-02","hours":4}]

date

string

required

The date for this hour configuration

Example:

2021-01-01

hours

number

required

The number of hours for this date

Example:

timezone

string

required

The timezone of the time off request

Example:

America/New_York

utcOffset

number

required

The UTC offset of the time off request

Example:

240

isAllDay

boolean

required

Whether the time off request is whole day

Example:

false

submittedAt

string

required

The date and time the time off request was submitted

Example:

2021-01-01T00:00:00.000Z

remainingBalance

number | null

required

The remaining balance of the worker in the policy when this time off request was approved

Example:

totalHours

number

required

The total hours of the time off request

Example:

workerPolicy

object

optional

The worker policy of the time off request

Example:

{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Policy 1"}

string

required

The ID of the worker policy

hoursBalance

number

required

The hours balance for the worker

isIncluded

boolean

required

Whether the worker is included

availableBalance

number

optional

The available balance for the worker

Get Time-Off Request

Create a time off request