WOworkiz
Availability

Retrieve blocking entities for a date

Changed on

Beta: 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.

get/v2/availability/blockingEntities

Request

Query parameters

datestring required
Example:2026-01-15

The date to retrieve blocking entities for, in YYYY-MM-DD format. Cannot be in the past.

slotLengthnumber
Example:60

The slot length in minutes. Must be between 30 and 480 (8 hours) in steps of 30. Defaults to the account configured slot length when omitted.

jobTypesstring
Example:JT-8718036049ec4c4d

Comma-separated list of job type IDs (prefix JT-). When provided, availability is restricted to the technicians who can perform any of those job types.

availableBasednumber
Example:1

Overrides the account capacity mode for this request only: 0 = no capacity limit, 1 = based on available technicians, 2 = maximum jobs per slot. Defaults to the account configured mode when omitted.

totalSpotsnumber
Example:3

Overrides the total capacity per slot for this request only. Mainly useful together with availableBased=2 to set the maximum jobs per slot without changing the account settings.

scheduleOffsetnumber
Example:24

Overrides the minimum notice window in hours for this request only. Allowed values: 0 (none), 1–10 (hours), or 24/48/72/96/120/144/168 (1–7 days). Slots earlier than now plus this offset are excluded. Defaults to the account configured schedule offset when omitted.

showHolidaysnumber
Example:1

Overrides whether public holidays block slots for this request only: 0 = ignore holidays, 1 = apply the holiday calendar. Defaults to the account configured setting when omitted.

ignoreUserAvailabilityboolean

When true, ignores per-technician working hours for this request and computes availability from business hours and account-level capacity only.

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

A list of entities blocking availability on the requested date.

totalResultsnumber

The total number of slots on the requested date.

Example response

{
  "totalResults": 100,
  "data": [
    {
      "startTime": "2026-01-15 09:00",
      "startTimestamp": 1768460400,
      "blockingEntities": [
        {
          "type": "job",
          "id": "JOB-BA5r7o4bqzR9MONa",
          "name": "Plumbing repair"
        }
      ]
    }
  ]
}

Changes

  • a2110eaa32f2Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • e789622c50efRevision changes
    • info

      added the new optional query request parameter ignoreUserAvailability