Docs
Get Event Types
GET /eventTypes?includeArchived=false
GET
/eventTypes?includeArchived=falseRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Organization token | x-Organization-Token | Optional | Run **Authorize Organization** in the Authorization folder. |
Returns all event types for the organization, including their sections and attribute assignments. The organization is resolved from the x-Organization-Token header.
Requires OrganizationAdmin permission.
Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| includeArchived | bool | Optional | Include archived types. Defaults to `false`. |
Response
| Field | Type | Description |
|---|---|---|
| id | Guid | Type ID. |
| name | string | Display name. |
| icon | string| null | Icon identifier. |
| color | string| null | Display color. |
| isArchived | bool | Whether the type is archived. |
| sections | Section[] | Sections within the type. |
Section
| Field | Type | Description |
|---|---|---|
| id | Guid | Section ID. |
| name | string | Section display name. |
| index | int | Display order within the type. |
| attributes | Assignment[] | Attribute assignments in the section. |
Assignment
| Field | Type | Description |
|---|---|---|
| attributeId | Guid | The assigned attribute's ID. |
| name | string | Attribute display name. |
| type | string | Attribute type. |
| isRequired | bool | Whether the attribute is required on events of this type. |
| isTaskTracked | bool | Whether filling the attribute is tracked as a task. |
| isTaskReviewRequired | bool | Whether the tracked task requires review. Only meaningful when `isTaskTracked` is true. |
| index | int | Display order within the section. |