Authentication
Every request to /api/v1/ must include a Bearer token in the
Authorization header:
Authorization: Bearer kennel_pk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Key format
Every key starts with the prefix kennel_pk_live_ followed by 40+ characters
of url-safe base64. The full plaintext is shown once on creation; only
a SHA-256 hash and the last 4 characters (the "suffix") are stored.
Scopes
Each key carries one or more scopes. The middleware rejects a request with
403 scope_missing if the endpoint requires a scope the key lacks.
| Scope | Grants |
|---|---|
bookings:read | List + read bookings |
bookings:write | Create + update bookings |
customers:read | List + read customers |
customers:write | Reserved (not yet exposed) |
pets:read | List + read pets |
pets:write | Reserved (not yet exposed) |
payments:read | List + read payments |
services:read | List services catalogue |
webhooks:manage | Reserved for the outbound-webhooks surface |
* | Wildcard — every scope |
Error responses
| Status | Error | Cause |
|---|---|---|
| 401 | unauthenticated | Missing, invalid, revoked, or expired key. |
| 402 | tier_locked | Account is not on the Enterprise plan. |
| 403 | scope_missing | Key lacks the required scope. |
| 429 | rate_limited | Over the 100 rpm budget. Honour the Retry-After header. |
Revoking a key
From Settings → API keys, click Revoke next to the key.
Revocation is immediate; subsequent requests using that key return 401.
Tier requirement
API access and outbound webhooks are part of the Enterprise plan.
Other plans can still use the in-app integrations, but the
/api/v1/ Bearer-key surface is gated.
Fetch Public API · OpenAPI 3.1 spec at
/api/v1/openapi.json