Authentication & API keys
This is the URL that should prefix all API requests: https://api.brella.io/api/integration/.
Note: All requests should be made over SSL.
Authentication works by sending your unique API key using the Brella-API-Access-Token header to your request.
If you have purchased API access, all organization admins in your Brella organizatio should see an “API key” section in the organization view of your Admin Panel.
Note: The “API key” option is not available to event admins and sponsor admins.
Click on the green “Create key” button to generate a unique API key. The generated API key is tied to the organization admin who generated it — and is valid for accessing data in every organization they are a part of. If that organization admin is removed from an organization, the API key will not be able to access data within it.
The Brella API works with json data. In addition to the Authentication header (Brella-API-Access-Token: [APIKEY]), every request must contain the following headers:
Content-Type: application/json
Accept: application/vnd.brella.v4+json
This API is organized around REST. All request and response bodies, including errors, are encoded in JSON.
Request bodies have no root element and use snake_case for object keys.
Response bodies comply with the JSON API specification.