Integration API quickstart
Forming API requests
4min
the brella api works with json data e very request made to the api must contain the following headers brella api access token \[apikey] 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 for post, put and patch requests use snake case for object keys response bodies comply with the json api specification if you need help finding a suitable deserializer, please visit the official implementation guidelines for the json api specification query parameters to ensure efficient performance and distribute system resources evenly, pagination is mandatory for all get endpoints that return multiple objects as of january 8, 2025 pagination is controlled using the following query parameters page\[size] specifies the number of records per page (maximum 500) page\[number] indicates the page number to retrieve more details rate limiting & pagination docid\ cgvifx1fhh7jcc4dqplzx path params depending on the endpoints, we would require the path params as organization id and event id the organization id can be found in the url when navigating to the admin panel under organization home page for example https //manager brella io/dashboard/organizations/1234/home/event in this case 1111 is the organization id the event id can be found in the url when navigating to the admin panel under the event for example https //manager brella io/dashboard/events/5678/home in this case 5678 is the event id