Make your first request

Read your first event records, understand the result, and choose the next task.

Start with a read request. You need your organization ID, event ID, and a Core API token whose registrant scope has Read access to that event. Ask your organization administrator for these; an Integration API token will not work.

Prepare your environment

Set BRELLA_API_BASE_URL to https://api.brella.io, or the sandbox address supplied by Brella. Set BRELLA_API_ACCESS_TOKEN in your local environment or your execution tool’s secret store. Keep the token out of chat messages, source files and screenshots.

The examples use the Brella-API-Access-Token header and Accept: application/vnd.brella.v4+json. The authentication guide explains token setup.

Build and copy a request

Replace the fictional IDs, copy the request, then run it in your own terminal or authorized API tool.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request GET \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/registrants?page%5Bnumber%5D=1&page%5Bsize%5D=30' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}"

Understand the result

A successful list request returns 200 OK and a JSON document. For example, a token with external_id selected as a readable field could receive:

{
  "data": [{ "id": "1201", "type": "registrant", "attributes": { "external-id": "CRM-10042" } }],
  "meta": { "total_count": 1, "total_pages": 1, "current_page": 1 }
}

This is an illustrative response. Your records and fields depend on the token scope. An empty data array means there are no matching accessible records; an ID-only record can be valid when no additional readable fields are selected.

For more pages, increment page[number] until it reaches meta.total_pages. Read filters and includes before exporting a full dataset.

Choose your next task

• Import a registrant without an invitation email.
• Build an agenda and connect speakers.
• Export leads with registrant details.
• Work with an AI agent.

If the request fails, start with responses and errors. A 404 can reflect an inaccessible organization, event or resource scope; it is not always a bad record ID.