Registrants

Registrants: available fields, filters, associations, and API operations.

Release timing: This page includes changes planned for 9 October 2026. See the deployment note before using the updated operations or inputs.

Operations

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' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}"

{
  "data": [
    {
      "id": "1201",
      "type": "registrant"
    }
  ],
  "meta": {
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

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/1201' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}"

{
  "data": {
    "id": "1201",
    "type": "registrant"
  }
}

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request POST \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/registrants' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "external_id": "CRM-10042",
  "external_email": "alex@example.com",
  "external_first_name": "Alex",
  "external_last_name": "Morgan",
  "send_email": false
}'

{
  "data": {
    "id": "1201",
    "type": "registrant"
  }
}

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request PATCH \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/registrants/1201' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "external_title": "SVP Partnerships",
  "pitch": "Expanding our partner network",
  "custom_list_ids": [
    401,
    403
  ],
  "selected_interests": [
    {
      "interest_id": 701,
      "intent_ids": [
        801
      ]
    }
  ],
  "send_email": false
}'

{
  "data": {
    "id": "1201",
    "type": "registrant"
  }
}

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request DELETE \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/registrants/1201' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}"

Path: events/{event_id}/registrants

Methods: GET collection/record, POST, PATCH, DELETE.

Fields, filters and associations

• Filters: status, email, external_id, external_email, fill_token, ticket_type_list_id, custom_list_id, created_from, created_to, updated_from, updated_to.
• Associations:
  • ticket_type_list → response ticket-type: name;
  • custom_lists → custom-lists: name;
  • persona, function, industry: name;
  • selected_interests → response interests: interest-id, interest-name, intent-id, intent-label;
  • blocked_times → response blocked-times: start-time, end-time, created-at, updated-at;
  • custom_fields → response custom-fields: definition-key, definition-title, field-type, role, visible-to-sponsors, values;
  • selected_sponsor → response selected-sponsor: name.

GET .../registrants?status=joined&custom_list_id=401&include=ticket-type,custom-lists,custom-fields

Writing this resource

Writable fields: external_id, external_email, external_first_name, external_last_name, external_company, external_title, pitch, skip_networking, appearance, ticket_type_list_id.

Additional inputs: external_qr_string, custom_list_ids (array), persona, function, industry, selected_interests (raw JSON), custom_fields_attributes (raw JSON), seats, send_email.

{
  "external_id": "CRM-10042",
  "external_email": "alex@example.com",
  "external_first_name": "Alex",
  "external_last_name": "Morgan",
  "external_company": "Example Ltd",
  "external_title": "VP Partnerships",
  "ticket_type_list_id": 301,
  "custom_list_ids": [401, 402],
  "persona": "Buyer",
  "function": "Partnerships",
  "industry": "Technology",
  "selected_interests": [
    { "interest_id": 701, "intent_ids": [801, 802] }
  ],
  "send_email": false
}

persona, function, and industry are names, not IDs. selected_interests uses plural intent_ids. When custom_list_ids is supplied, it fully replaces custom-list membership; every list must belong to the event. send_email defaults to true when omitted. PATCH uses the invited-registrant update flow and can therefore be rejected by its business rules.

External and internal QR values

Map the external_qr_string input to create or update an external badge/scanning value. It works for invited and joined registrants, including direct overrides on a joined record. Values must be unique within the event and at most 255 characters. Internal Brella QR formats, including encoded or normalized variants, are rejected with a validation error.

Null or blank clears the target record’s override. The readable external-qr-string is the effective external value: a joined registrant without its own override can inherit the value from a claimed personal invite. Clearing an override can therefore reveal that invite’s value instead of returning null. The separately readable internal-qr-string preserves the stable Brella value regardless of an external override. Allow these fields only for integrations that need them, and verify the effective result with a permitted GET or write response.

See QR request examples.