Skip to content
Core API
Esc
↑↓navigate↵open⌘Jpreview
On this page

Custom lists

Custom lists: available fields, filters, associations, and API operations.

Operations

Event-level resource. Every operation requires an enabled Core API scope for this resource and access to the URL context.

GETList records

/api/core/organizations/123/events/456/custom-lists

Permission: Read access. Readable fields, query filters and related objects must be selected in the scope.

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

Response: 200 OK. A JSON:API data array and pagination metadata. Default page size 30; maximum 100.

View response structure
{
  "data": [
    {
      "id": "1201",
      "type": "custom-list"
    }
  ],
  "meta": {
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

Illustrative, with no additional response fields selected.

Errors: 400 for invalid parameter shapes; 403 for a missing/expired token or disallowed operation; 404 when the URL context, record or a referenced record is inaccessible; 429 for rate limits. Troubleshooting and retry guidance.

GETGet a record

/api/core/organizations/123/events/456/custom-lists/1201

Permission: Read access. Readable fields, query filters and related objects must be selected in the scope.

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

Response: 200 OK. A JSON:API data object; fields depend on the token scope.

View response structure
{
  "data": {
    "id": "1201",
    "type": "custom-list"
  }
}

Illustrative, with no additional response fields selected.

Errors: 400 for invalid parameter shapes; 403 for a missing/expired token or disallowed operation; 404 when the URL context, record or a referenced record is inaccessible; 429 for rate limits. Troubleshooting and retry guidance.

POSTCreate a record

/api/core/organizations/123/events/456/custom-lists

Permission: Write access with the create action. Every request key must map to an allowed writable field; unconfigured inputs are ignored.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request POST \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/custom-lists' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "VIP guests"
}'

Response: 201 Created. Save data.id for later requests. Attributes come from Write-response fields.

View response structure
{
  "data": {
    "id": "1201",
    "type": "custom-list"
  }
}

Illustrative, with no additional response fields selected.

Errors: 400 for invalid parameter shapes; 403 for a missing/expired token or disallowed operation; 404 when the URL context, record or a referenced record is inaccessible; 422 for validation or business rules; 429 for rate limits. Troubleshooting and retry guidance.

PATCHUpdate a record

/api/core/organizations/123/events/456/custom-lists/401

Permission: Write access with the update action. Every request key must map to an allowed writable field; unconfigured inputs are ignored.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request PATCH \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/custom-lists/401' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "VIP and hosted buyers",
  "registrant_ids": [
    1201,
    1202,
    1203
  ]
}'

Response: 200 OK. Attributes come from Write-response fields; these can differ from readable fields.

View response structure
{
  "data": {
    "id": "1201",
    "type": "custom-list"
  }
}

Illustrative, with no additional response fields selected.

Errors: 400 for invalid parameter shapes; 403 for a missing/expired token or disallowed operation; 404 when the URL context, record or a referenced record is inaccessible; 422 for validation or business rules; 429 for rate limits. Troubleshooting and retry guidance.

PATCH changes supplied fields. Collection inputs can replace existing values; read the input notes before sending arrays.

DELETEDelete a record

/api/core/organizations/123/events/456/custom-lists/1201

Permission: Write access with the delete action.

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

Response: 204 No Content, with an empty response body.

Errors: 400 for invalid parameter shapes; 403 for a missing/expired token or disallowed operation; 404 when the URL context, record or a referenced record is inaccessible; 422 for validation or business rules; 429 for rate limits. Troubleshooting and retry guidance.

Deletion can remove related data or be refused by resource constraints. Read the resource notes and confirm the target before using this operation.

Path: events/{event_id}/custom-lists
Methods: GET collection/record, POST, PATCH, DELETE.

Fields, filters and associations

Browse 24 response fields

The scope chooses these response fields. id is always returned. Configuration names and response names can differ.

event-id
Scope field: event_id
name
Scope field: name
description
Scope field: description
attendance-type
Scope field: attendance_type
profile-badge
Scope field: profile_badge
display-name
Scope field: display_name
is-default
Scope field: is_default
position
Scope field: position
networking-enabled
Scope field: networking_enabled
lead-scanning-enabled
Scope field: lead_scanning_enabled
qr-code-visible
Scope field: qr_code_visible
meeting-requests-outgoing
Scope field: meeting_requests_outgoing
meeting-requests-incoming
Scope field: meeting_requests_incoming
max-outgoing-meeting-requests
Scope field: max_outgoing_meeting_requests
max-accepted-meetings
Scope field: max_accepted_meetings
show-invited-registrants
Scope field: show_invited_registrants
created-at
Scope field: created_at
updated-at
Scope field: updated_at
show-unjoined-registrants-in-apps
Scope field: show_unjoined_registrants_in_apps
show-registration-link
Scope field: show_registration_link
outgoing-target-list-ids
Scope field: outgoing_target_list_ids
incoming-target-list-ids
Scope field: incoming_target_list_ids
registrant-ids
Scope field: registrant_ids
registrants-count
Scope field: registrants_count
  • Filters: attendance_type, name, registrant_id.
  • Associations: none.
GET .../custom-lists?attendance_type=in_person&registrant_id=1201

Writing this resource

Writable fields: name, description, attendance_type, profile_badge, display_name, networking_enabled, lead_scanning_enabled, qr_code_visible, meeting_requests_outgoing, meeting_requests_incoming, max_outgoing_meeting_requests, max_accepted_meetings, show_invited_registrants.

Additional inputs: show_invites_in_apps, show_booking_system_join_url, outgoing_target_list_ids (array), incoming_target_list_ids (array), registrant_ids (array).

{
  "name": "VIP guests",
  "attendance_type": "in_person",
  "networking_enabled": true,
  "registrant_ids": [1201, 1202]
}

When supplied on POST or PATCH, registrant_ids fully replaces membership. An empty array removes all members without deleting the registrants. All registrants and target lists must belong to the URL event.

Last updated on August 21, 2026