WORKFLOWSTATUS: Workflow Status
A single status within a workflow, defining its display name, colour, icon, and position in the sequence.
Default definition. This article describes the default
WORKFLOWSTATUS definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches WORKFLOWSTATUS.Entity properties
| Property | Value |
|---|---|
| Entity code | WORKFLOWSTATUS |
| Display name | Workflow Status |
| Plural | Workflow Statuses |
| Level | 11110 |
Use cases
A single status within a workflow, defining its display name, colour, icon, and position in the sequence.
Child of WORKFLOW, stored in the statuses objectarray. Each status has a unique statusId used as the key for transitions and for work item statusId fields. The order field controls column sequence in kanban views. The isFinal flag marks terminal statuses (e.g. Done, Cancelled) which can be used to filter completed items.
Fields
General
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Label shown in kanban columns and status dropdowns |
colour | color | Status colour for kanban columns and badges | |
icon | text (FA icon class) | Font Awesome icon for this status | |
order | number | Display order (lowest first) | |
isFinal | boolean | Mark as a terminal/completed status (e.g. Done, Cancelled) |
Relationships
No declared relationships in the default definition.
Creating a Workflow Status via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "WORKFLOWSTATUS",
"level": 11110,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"colour": "Example colour",
"icon": "Example icon",
"order": 0
}Listing Workflow Statuses
GET /v1/entities/WORKFLOWSTATUS/SUB