Skip to main content

Partner API v1

API reference

This catalog is intentionally smaller than ClassFlow's internal API. It exposes stable, studio-bounded projections and governed actions without payment credentials, refunds, payroll, private staff notes, or internal AI operations.

ResourceActionsScope
StudioGET /studiostudio:read
LocationsGET /locations · GET /locations/{id}studio:read
RoomsGET /rooms · GET /rooms/{id}schedule:read
Class typesGET /class-types · GET /class-types/{id}schedule:read
InstructorsGET /instructors · GET /instructors/{id}schedule:read
Classes and availabilityGET /classes · GET /classes/{id}schedule:read
Products and pricesGET /products · GET /products/{id}catalog:read
Form definitionsGET, POST /forms · GET, PUT /forms/{id}forms:read / forms:write
Form submissionsGET, POST /forms/{id}/submissions · GET /forms/{id}/submissions/{submissionId}form_submissions:read / form_submissions:write
LeadsGET, POST /leads · GET, PATCH /leads/{id}leads:read / leads:write
Members and membershipsGET, POST /members · GET /members/{id} · GET /members/{id}/memberships · GET /memberships/{id}members:read / members:write
Bookings and waitlistGET, POST /bookings · GET, DELETE /bookings/{id} · GET /waitlist · GET /waitlist/{id}bookings:read / bookings:write
PurchasesGET /purchases · GET /purchases/{id}purchases:read

Pagination

List responses contain data, has_more, and next_cursor. Pass the returned cursor unchanged. Page size defaults to 50 and is capped at 200.

Idempotent booking writes

Booking creation and cancellation require an Idempotency-Key header. Results are replayable for 24 hours; reusing a key for another request returns 409.

Interactive schema

Inspect request models, execute test calls, or download the current OpenAPI JSON from the API itself.