Api referenceClasses
List classes (the timetable)
Group classes scheduled in a window (default: the next 7 days, at most 31). Each row carries how many spots are booked and how many are left. Only gyms and studios run classes; other businesses get an empty list.
Authorization
ApiKeyAuth AuthorizationBearer <token>
Send your API key as a bearer token: Authorization: Bearer bp_sk_live_.... Mint and revoke keys in your dashboard under Settings -> Developers.
In: header
Query Parameters
location_id?string
Restrict to a single location. Must be one the key can access.
Format
uuidfrom?string
Window start (ISO 8601). Defaults to now.
Format
date-timeto?string
Window end (ISO 8601). Defaults to from + 7 days; at most 31 days after from.
Format
date-timeservice_id?string
Only classes of this service.
Format
uuidlimit?integer
Range
1 <= value <= 100Default
25cursor?string
The next_cursor from a previous page.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/classes"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "technician_id": "557e6e8c-3c29-4825-b73f-0884ad39f2d9", "technician_name": "string", "start": "2019-08-24T14:15:22Z", "end": "2019-08-24T14:15:22Z", "capacity": 0, "booked": 0, "spots_left": 0, "waiting": 0, "status": "scheduled" } ], "next_cursor": "string"}