Events

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

Operations

Organization-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

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' \
  --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": "event"
    }
  ],
  "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/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/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": "event"
  }
}

Illustrative, with no additional response fields selected.

PATCHUpdate a record

/api/core/organizations/123/events/456

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' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "Customer Summit 2027",
  "start_date": "2027-04-12",
  "end_date": "2027-04-14"
}'

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

View response structure

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

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.

Path: events at organization level, for example /api/core/organizations/30/events
Methods: GET collection/record, PATCH. DELETE is available only in sandbox. POST is never available to Core organization tokens.

Fields, filters and associations

Browse 7 response fields

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

name: Scope field: name
start-date: Scope field: start_date
end-date: Scope field: end_date
join-code: Scope field: join_code
public-code: Scope field: public_code
event-type: Scope field: event_type
registrant-count: Scope field: registrant_count

Filter: event_type.
Associations: timeslots and organization, both linkage-only with no configurable association attributes.
Row restriction: event_type may be restricted by the administrator. The scope’s event selection also limits this collection.

GET /api/core/organizations/30/events?event_type=in_person
GET /api/core/organizations/30/events/319986

PATCH inputs: name, start_date, end_date.

{
  "name": "Customer Summit 2027",
  "start_date": "2027-04-12",
  "end_date": "2027-04-14"
}

Event creation is not supported because the Core token has no acting user to own the event. Event deletion is removed from introspection and rejected outside a sandbox environment.