v1

latestOpenAPI 3.0.12026-07-133870165.8 KB

Availability

Get Unavailable Times

This endpoint is used to show Unavailable times and provides valuable information as to why a time slot is unavailable. If you question your availability results, populate the same parameters to this endpoint to find out why.

A serviceId is required. The startDate and endDate are required and are formatted as: YYYY-MM-DD

Location hours, holidays, services, resources, blocks, allocations, and appointments are just some of variables that may cause time slots to become unavailable. Use this endpoint to understand why you don't see availability.

get/consumer/v1/availability/{serviceId}/{startDate}/{endDate}/unavailable

Path parameters

serviceIdstring required

Service Id for availability search

startDatestring date-time required

Format YYYY-MM-DD: Start Date for unavailable time search

endDatestring date-time required

Format YYYY-MM-DD: End Date for unavailable time search

Query parameters

locationIdstring

Id of business location, defaults to primary business location

resourceIdstring

Resource Id to filter on

resourceIdsstring

Comma separated Resource Id(s) for availability search

durationinteger

Duration of the service if different from default

tzOffsetinteger

Request timezone offset to view unavailable times

skipTimePastUnavailabilityboolean

Set as true to remove Time Past (TP) blocks in the response

Response

Success

objectstring nullable

urlstring nullable