Statuses

Workflow statuses that represent the current state of a record (e.g. New, In Progress, Closed) and the workflows that group them. Statuses come in two levels, both managed under this tag.

A status-system (/status-system) is a named workflow (pipeline) bound to a module — e.g. "Invoice pipeline" or "Support tickets". It defines which statuses exist for that module and the rules for moving between them. Its module field binds it to a module and systemName is a stable machine-readable identifier for built-in workflows; actived marks it enabled, and when custom=false it is platform-defined and cannot be deleted. Transitions are validated by its allowMove rules.

A status (/status) is a single state inside one of those workflows. Each status has a name, color, icon, icon_prefix, and weight (display order), and always belongs to a status-system via statusSystemId. Custom statuses can be added by users; system statuses (custom=false) are platform-defined and have restricted modification.

In short: the status-system is the container/workflow, the status is an individual state within it. When transitioning a record, use the statusId field along with statusSystemId; the API enforces that the target status belongs to the record's bound workflow.

Status Actions (/status/{id}/action) define automated side-effects triggered on status change (e.g. send email, trigger notification).