14666f4db0f8
Retrieve blocking entities for a date
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
The date to retrieve blocking entities for, in YYYY-MM-DD format. Cannot be in the past.
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.
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.
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.
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.
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.
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.
Headers
Bearer Token
Response
A list of entities blocking availability 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"
}
]
}
]
}