Authentication
The Beeving API uses Bearer tokens to authenticate requests.
Get a Token
- Log in to app.beeving.com
- Go to Settings → API Tokens
- Click New token
- Give it a name and select permissions
- Copy the token (shown only once)
Use the Token
Add the Authorization header to every request:
Authorization: Bearer your_token_hereExample
bash
curl https://app.beeving.com/api/v1/contacts \
-H "Authorization: Bearer bee_live_xxxxxxxxxxxx"Permissions
Tokens are scoped to the permissions selected at creation. Accessing a resource without the required permission returns 403 Forbidden.
| Permission | Access |
|---|---|
contacts:read | Read contacts |
contacts:write | Create and update contacts |
campaigns:read | Read campaigns |
campaigns:write | Create and manage campaigns |
crm:read | Read CRM data |
crm:write | Create and update CRM data |
webhooks:write | Manage webhooks |
analytics:read | Access analytics |
Security
WARNING
Never share your API tokens. Treat them like passwords.
- Store tokens in environment variables
- Create separate tokens per application or service
- Immediately revoke any compromised token from Settings
- Use tokens with the minimum required permissions
Authentication Errors
json
{
"message": "Unauthenticated.",
"errors": null,
"code": 401
}If you receive this error, verify that:
- The token is included in the
Authorizationheader - The format is
Bearer <token>(with theBearerprefix) - The token has not been revoked
