Docs

Get Task Attributes

GET /taskAttributes

GET/taskAttributes

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Event tokenx-Event-TokenOptionalRun **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually.

Returns all custom attribute definitions for tasks in the event. These define the schema for additional fields on tasks (e.g. custom dropdowns, text fields, dates).

Requires EventProjectManagementAdmin permission on the event.

Response

Returns an array of task attribute definitions.

FieldTypeDescription
idGuidUnique attribute ID.
namestringDisplay name.
typestringAttribute type (`Select`, `MultiSelect`, `Text`, `RichText`, `Number`, `Date`, `DateTime`, `Checkbox`, `Link`).
isRequiredboolWhether this attribute must be set on every task.
optionsOption[]Available options (for `Select`/`MultiSelect` types).

Option

FieldTypeDescription
idGuidUnique option ID.
valuestringDisplay value.
colorstringOption color.