Docs

Get Event Attributes

GET /Organizations/{organizationId}/eventAttributes

GET/Organizations/{organizationId}/eventAttributes

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Organization tokenx-Organization-TokenOptionalRun **Authorize Organization** in the Authorization folder.

Returns all custom event attributes defined for the organization. These attributes are applied to events at creation time.

Requires OrganizationBasicAccess permission.

Path Parameters

FieldTypeRequiredDescription
organizationIdGuidRequiredThe organization to retrieve attributes for.

Response

Returns an array of event attribute definitions.

FieldTypeDescription
idGuidUnique attribute ID.
namestringDisplay name of the attribute.
typestringAttribute type (e.g. `Select`, `Text`, `Date`).
isRequiredboolWhether this attribute is required when creating an event.
optionsOption[]Available options (for `Select`/`MultiSelect` types).

Option

FieldTypeDescription
idGuidUnique option ID.
valuestringDisplay value of the option.
colorstringColor associated with the option.