Skip to main content

Definitions

The Definitions API helps external tools stay aligned with workspace taxonomy: managed tags, issue statuses, priorities, and customer custom fields. Definitions are read-only through the REST API. Create and edit them in Woes Settings so permissions, validation, and usage counts stay consistent.

Tags

Tags include id, name, scope, color, and description.

Statuses

Statuses include lifecycle metadata, enabled state, rank, tone, and color. Use them when mirroring Woes issues into another system.

Priorities

Priorities include rank, tone, color, enabled state, and whether the priority is highlighted in the queue.

Custom Fields

Custom fields include sanitized field definitions: id, label, type, enabled, fillMode, description, and any select options.
The API returns definitions only. It does not return customer field values stored on individual conversations or accounts.

Required Scope

Every Definitions endpoint requires definitions:read.
Last modified on June 29, 2026