GET
/api/public/v1/appointment-availability

List availability windows

List weekly availability windows when a location accepts appointments.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

appointments:read

Query Parameters

NameTypeRequiredDescription
locationIdstringRequiredLocation to query.
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/appointment-availability" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Appointment availability retrieved successfully!",
  "content": {
    "availability": [
      {
        "id": "av_1",
        "dayOfWeek": 1,
        "startTime": "09:00",
        "endTime": "17:00",
        "isActive": true
      }
    ]
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Scheduling → Availability
/scheduling/availability