Docs
Get Attribute Profile
GET /Events/{eventId}/attributes
GET
/Events/{eventId}/attributesRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. |
Returns the event's assembled attribute profile — its type plus all sections, assignments, current values, and task status. The Event API joins the org-side type definition via the organization service. Untyped events return a null eventTypeId and no sections.
Requires read access to the event.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| eventId | Guid | Required | The event to retrieve the attribute profile for. |
Response
| Field | Type | Description |
|---|---|---|
| eventTypeId | Guid| null | The event's type ID. `null` when the event is untyped. |
| typeName | string | Display name of the type. |
| icon | string | Type icon identifier. |
| color | string | Type display color. |
| sections | Section[] | Sections of the type. |
Section
| Field | Type | Description |
|---|---|---|
| id | Guid | Section ID. |
| name | string | Section display name. |
| index | int | Display order within the type. |
| attributes | Attribute[] | Attributes in the section. |
Attribute
| Field | Type | Description |
|---|---|---|
| attributeId | Guid | Attribute ID. |
| name | string | Attribute display name. |
| type | string | Attribute type. |
| isRequired | bool | Whether the attribute is required. |
| isTaskTracked | bool | Whether filling the attribute is tracked as a task. |
| isTaskReviewRequired | bool | Whether the tracked task requires review. |
| index | int | Display order within the section. |
| value | string| null | Current value. `null`/blank when unset. |
| options | Option[] | Available options (`Select` / `MultiSelect` only). |
| taskId | Guid| null | The tracking task ID, when task-tracked. |
| taskStatus | string | Task status. One of: `NotStarted`, `NeedsReview`, `Done`. |
| canReview | bool | Whether the current user may approve the review. |
Option
| Field | Type | Description |
|---|---|---|
| id | Guid | Option ID. |
| value | string | Option value. |
| color | string | Display color. |
| isArchived | bool | Whether the option is archived. |