Skip to main content
The Partner API uses standard HTTP status codes. On error, the currently available endpoints return a flat JSON body with a single error string: 
{
  "error": "Invalid or revoked API key"
}
The 403 Insufficient scope response additionally includes the list of missing scopes: 
{
  "error": "Insufficient scope",
  "missing": ["treatments:read"]
}
Key your handling on the HTTP status code. The error string is human-readable and may change — do not parse it.

​
Error catalogue (live endpoints)

HTTPExample errorWhen it happens
401Missing API keyNo Authorization / X-Api-Key header
401Invalid or revoked API keyKey is unknown, expired or revoked
403Insufficient scopeKey lacks the scope required by the endpoint
403ForbiddenKey is scoped to a different venue than the one requested
404Venue not foundUnknown venue id, or the venue is not public
500variesUnexpected server error — retry with backoff
Retry 500 responses with exponential backoff (e.g. 2s, 4s, 8s, max 3 retries). Do not retry 4xx errors without fixing the request.
A richer, structured error format ({ "error": { "code", "message", "details" } }) with machine-readable codes such as SLOT_TAKEN will ship alongside the availability and booking endpoints. Those pages are tagged Coming soon in the API Reference.