Website logo
⌘K
API quickstart
Welcome
Forming API requests
Response status codes
Rate-limiting & pagination
How data is structured in Brella
A note on external_id fields
Authentication & API keys
Changelog
Events
Invites
Attendees
RSVP & Session check-in
Get all RSVPs by attendee id
Get all RSVPs by timeslot id
Create RSVP for timeslot
Delete RSVP from timeslot
Sponsors
Speakers
Schedule
Statistics & analytics
Get all meetings & chats by attendee id (cloned)
Get meeting or chat by id
Get tracking sessions by attendee id
Get tracking session slices by attendee id
Webhooks
Docs powered by Archbee
API quickstart

Authentication & API keys

4min

Base URL

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

Authentication works by sending your unique API key using the Brella-API-Access-Token header to your request.

Getting your unique API key

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.



Document image




Document image


Content type & data format

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.



Updated 18 Aug 2023
Did this page help you?
PREVIOUS
A note on external_id fields
NEXT
Changelog
Docs powered by Archbee
TABLE OF CONTENTS
Base URL
Authentication
Getting your unique API key
Content type & data format
Docs powered by Archbee