Scopes
Scopes how a user or API access token can interact with a Bunny object
Scopes are assigned to User Roles or API Client applications to limit the level of access that is available to that client or user.
We recommend using the principle of least privileged access. This means that you should only assign the scopes that are required to perform the API requests that you want to do.
Use this list of scopes to determine which ones you need to build your API application.
| Scope | Description |
|---|---|
| admin:read | View templates, and objects |
| admin:write | Create, update or delete templates, and objects |
| analytics:read | View analytics dashboards |
| analytics:write | Create, update or delete analytics dashboards |
| billing:read | View billing, currencies, transactions, and payments |
| billing:write | Create, update or delete billing, currencies, transactions, and payments |
| developer:read | View API client applications |
| developer:write | Create, update or delete API client applications |
| owner:read | View account owner settings |
| owner:write | Modify account owner settings |
| product:read | View products, product plans, and features |
| product:write | Create, update or delete products, product plans, and features |
| security:read | View users, roles, and groups |
| security:write | Create, update or delete users, roles, and groups |
| standard:read | View contacts, deals, accounts, quotes, and subscriptions |
| standard:write | Create, update or delete contacts, deals, accounts, quotes, and subscriptions |
| workflow:read | View workflows |
| workflow:write | Create, update or delete workflows |
| signup:read | Minimum read permissions to signup for a subscription. |
| signup:write | Minimum write permissions to signup for a subscription. |
API client applicationsLink to API client applications section
When an API client requests an access token, it must also request the scopes that it wants access to. If the client request scopes that have not be assigned then an error will be raised and an access token will not be returned.