---
title: "Retrieve booking availability"
method: GET
path: "/v2/availability"
tags: ["Availability"]
---

# Retrieve booking availability

`GET /v2/availability`

> **Beta:** This endpoint is subject to change and may contain bugs. Breaking changes may occur without notice.

Returns the list of available booking slots for the account within the requested date range.

Only slots that still have open capacity are returned, so a day with no returned slots is fully booked or unavailable.

Each slot includes a `userIds` array containing the IDs of users who are already occupying capacity in that slot.

Use `jobTypes` to restrict availability to the technicians who can perform those job types, and `availableBased`/`totalSpots`/`scheduleOffset`/`showHolidays` to override account booking settings for the request without changing them.

The range cannot exceed 60 days.

## Query parameters

- `startDate` string
- `endDate` string
- `slotLength` number
- `jobTypes` string[]
- `availableBased` number
- `totalSpots` number
- `scheduleOffset` number
- `showHolidays` number

## Headers

- `Authorization` string, required

## Response `200`

A list of available booking slots.

- ResponseAvailabilitySlotsV2Dto
  - `totalResults` number — The total number of available booking slots within the requested range.
  - `data` ResponseAvailabilitySlotV2Dto[] — A list of available booking slots within the requested range.
    - `startTime` string — The start date and time of the slot in the account timezone, in `YYYY-MM-DD HH:mm` format.
    - `startTimestamp` number — The start time of the slot as a Unix timestamp in seconds.
    - `slotLength` number — The duration of the slot in minutes.
    - `totalSpots` number — The total number of bookings the slot can hold.
    - `openSpots` number — The number of bookings still available in the slot.
    - `userIds` string[] — Technicians unavailable in this slot. (prefix `USR-`)

## Other responses

- `400` — Invalid query parameters.
- `401` — Missing or invalid authentication token.

---

[API](https://skmtc.net/workiz/apis/developer-api.md) · [All operations](https://skmtc.net/workiz/apis/developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/workiz/developer-api/revisions/14666f4db0f8/schema)