Developers · Start here
API keys and customer tokens
Two kinds of credentials: API keys for the venue’s own systems, customer tokens for the venue’s customers.
API keys (admin)
An API key acts as the admin who created it, on one venue only.
- Create: an admin opens Settings → Assistant and API → API key (advanced), names the key and chooses Read only or
Read and change. The key (
bkp_+ 43 characters) is shown once. - Use:
Authorization: Bearer bkp_...on any/admin/...endpoint. - Lifetime: one year. Up to 10 keys per venue.
- Revoke: Disconnect on the same page. Effective immediately.
- Automatic revocation: if the admin who created the key leaves the team or becomes staff, all their keys stop working at once (checked on every request).
- Read only keys get
403 forbiddenon any change. - Audit: every change is written to the venue’s activity log as the key’s owner, marked as made through the API, with the key’s name.
- Where it may live: a server. Never put an API key in a browser, a mobile app or a public repository: it can do anything the admin can do through the API.
OAuth access tokens issued to AI assistants (see MCP) are accepted in the same way.
Customer tokens
For apps and sites where the venue’s customers sign in. No passwords: a code is sent to the customer’s email.
POST /auth/codewith{ "email" }→{ "challenge", "expires_in": 600 }.- The customer reads the 6-digit code from the email.
POST /auth/tokenwith{ "email", "code", "challenge" }→{ "token", "token_type": "Bearer", "expires_in", "customer" }.
The token is valid for 90 days. Send it as Authorization: Bearer <token> to /me/.... DELETE /auth/token signs out (revokes
it). Keep it like a session: in secure storage on mobile, in memory or an http-only cookie of your own on the web.
New customers
- Gyms and studios need a sign-up: include
signupin step 3:
{
"email": "new@example.com", "code": "482913", "challenge": "...",
"signup": { "name": "Eleni Papa", "phone": "6912345678", "goal": "Back pain", "injuries": "", "medical": "", "wants_news": true, "consent": true }
}
consent: true means the customer agreed to the venue keeping their details (and any health answers) as its privacy notice
says; show them a checkbox. If signup is missing for an email with no account, the answer is 422 with
"reason": "signup_required" and the code is not used up: collect the details and call again with the same code. New
members are pending until the venue approves them; booking (422) and buying (403) are refused until then.
- Appointments and stays: the account is created automatically, and earlier guest bookings with that email are attached to it.
Not for the team
Admins and staff cannot get customer tokens (403): they use API keys. This keeps two-step sign-in, which protects team
accounts, from being bypassed.
Public endpoints
/public/... need no credentials. They show only what the venue’s own booking pages already show.