Skip to main content

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.

ScopeGrants
bookings:readList + read bookings
bookings:writeCreate + update bookings
customers:readList + read customers
customers:writeReserved (not yet exposed)
pets:readList + read pets
pets:writeReserved (not yet exposed)
payments:readList + read payments
services:readList services catalogue
webhooks:manageReserved for the outbound-webhooks surface
*Wildcard — every scope

Error responses

StatusErrorCause
401unauthenticatedMissing, invalid, revoked, or expired key.
402tier_lockedAccount is not on the Enterprise plan.
403scope_missingKey lacks the required scope.
429rate_limitedOver 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