Skip to main content
GET
/
v1
/
scheduling
/
slots
Search appointment slots
curl --request GET \
  --url https://api.haau3.com/v1/scheduling/slots \
  --header 'Authorization: Bearer <token>'
{
  "slots": [
    {
      "id": "<string>",
      "scheduleId": "<string>",
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z",
      "serviceTypeCode": "<string>",
      "serviceTypeText": "<string>",
      "appointmentType": "<string>",
      "isVirtual": true,
      "bookingDeepLink": "<string>",
      "bookingPhone": "<string>",
      "location": {
        "name": "<string>",
        "phone": [
          "<string>"
        ],
        "website": [
          "<string>"
        ],
        "addressLine": [
          "<string>"
        ],
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>"
      },
      "provider": {
        "name": "<string>",
        "specialty": "<string>"
      }
    }
  ],
  "total": 4503599627370495
}

Authorizations

Authorization
string
header
required

Your platform API key (haau3_sk_…), sent as Authorization: Bearer <key>.

Query Parameters

status
enum<string>
default:free

Slot availability state to return. Defaults to free.

Available options:
free,
busy,
busy-unavailable,
busy-tentative
serviceTypeCode
string

Filter by service type code (as published by the source).

Minimum string length: 1
appointmentType
string

Filter by appointment type.

Minimum string length: 1
isVirtual
boolean

Filter to virtual (true) or in-person (false) slots.

city
string

Filter by the location's city.

Minimum string length: 1
state
string

Filter by the location's state.

Minimum string length: 1
startAfter
string<date-time>

Only slots starting at or after this ISO 8601 instant (with offset).

startBefore
string<date-time>

Only slots starting at or before this ISO 8601 instant (with offset).

limit
integer
default:25

Page size (1–100). Defaults to 25.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of slots to skip for pagination. Defaults to 0.

Required range: 0 <= x <= 9007199254740991

Response

Matching slots and the total pre-pagination count.

slots
object[]
required
total
integer
required
Required range: 0 <= x <= 9007199254740991