Partner API

Authentication

ClassFlow Partner API keys are server credentials for exactly one studio. Never ship a key in browser JavaScript, a mobile binary, an iframe, or a public repository.

Create a key

1. Open Settings → Developer in the studio workspace.
2. Choose Live or Test, name the integration, select the minimum scopes, and optionally restrict it to locations. Test keys are read-only against the studio's current data; ClassFlow does not imply a separate sandbox tenant.
3. Copy the key when it appears. ClassFlow stores only its hash and cannot reveal it later.

Send the key

GET /partner/v1/classes?starts_after=2026-08-02T00:00:00Z HTTP/1.1
Host: api.getclassflow.com
X-ClassFlow-Key: cf_live_••••••••••••
Accept: application/json

Scope model

Scopes are explicit grants such as schedule:read, forms:write, or bookings:write. A request is allowed only when the credential has the scope and, for protected mutations, the key's support owner still holds the matching studio permission. Optional location bounds further narrow schedule, booking, and purchase resources.

Rotation and revocation

Rotation creates a new one-time secret and immediately revokes the old key. Update the integration secret first in a coordinated maintenance window. Revocation is immediate. Existing audit and webhook delivery history is retained.

Errors