Data Share API Authentication
The Breesy Data Share API uses a franchise-scoped bearer token that you create yourself in the Breesy app.
Base URL
Use the Breesy API domain for all requests:
https://api.breesy.appCreating A Key
- Sign in to Breesy as a Power Admin for your franchise.
- Go to Settings and open the Data Share API Keys section.
- Create a key, give it a descriptive name, and copy the full token immediately.
- The full token is shown only once. Breesy stores only a hash and a non-secret key prefix for identification.
Each key is bound to the franchise it was created in and grants full access to that franchise’s Data Share API data.
Example Header
Authorization: Bearer <api_token>Expiration And Renewal
Tokens are valid for 24 months. When a token expires, create a new key from Settings.
If a token is compromised or no longer needed, revoke it from the same Settings screen. Revoked tokens stop working immediately.
Access Rules
- The franchise is derived from the token; you never pass
franchise_id. - A token can only read and write data for its own franchise.
location_id, when supplied, must belong to that franchise.
Expected Auth Errors
| Status | Meaning |
|---|---|
401 | Missing, invalid, expired, or revoked bearer token |
404 | The requested record does not exist within this franchise |