---
title: "Retrieve blocking entities for a date"
method: GET
path: "/v2/availability/blockingEntities"
tags: ["Availability"]
---

# Retrieve blocking entities for a date

`GET /v2/availability/blockingEntities`

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

Returns the entities (jobs, leads, tasks, events, recurrences, time-offs) that are occupying capacity on the requested date, including fully booked slots.

Use this endpoint to investigate why a specific date has reduced or no availability. Each entity includes a ID that can be used with the corresponding resource endpoint.

## Query parameters

- `date` string, required
- `slotLength` number
- `jobTypes` string[]
- `availableBased` number
- `totalSpots` number
- `scheduleOffset` number
- `showHolidays` number

## Headers

- `Authorization` string, required

## Response `200`

A list of entities blocking availability on the requested date.

- ResponseBlockingEntitiesV2Dto
  - `totalResults` number — The total number of slots on the requested date.
  - `data` ResponseBlockingEntityV2Dto[] — The list of slots and entities occupying them on the requested date.
    - `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.
    - `blockingEntities` BlockingEntitiesV2Dto[] — The entities occupying capacity in this slot.
      - `type` 'job' | 'lead' | 'task' | 'event' | 'recurrence' | 'timeOff' — The entity type occupying the slot.
      - `id` string — The ID of the entity. For recurrences this is the parent job ID. (prefixes `JOB-`, `LD-`, `TSK-`, `EVT-`, or `TO-`)
      - `name` string — The display name of the entity.

## 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)