Overview

States represent the current status of a work item in your project workflow.

Learn more about States

The state object

Attributes

• name string ( required )

  The state's name.

• created_at , updated_at timestamp

  When the state was created and when it was last updated.

• description string

  The state's description.

• color string (required)

  Display color as a hex code.

• workspace_slug string

  Slug of the state's name, generated by the system.

• sequence string

  Position used to order the state, generated by the system.

• group string (required)

  The group the state belongs to. One of:

  • backlog
  • unstarted
  • started
  • completed
  • cancelled

• default boolean

  Whether this is the project's default state. Work items created without a state are placed in the default state.

• created_by & updated_by

  Set automatically to the ID of the user who created or last updated the state.

• project uuid

  ID of the project the state belongs to. Set by the server.

• workspace uuid

  ID of the workspace the state belongs to. Set by the server.

Response200

{
  "id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "created_at": "2023-11-19T17:41:45.478363Z",
  "updated_at": "2023-11-19T17:41:45.478383Z",
  "name": "Ideation",
  "description": "",
  "color": "#eb5757",
  "workspace_slug": "ideation",
  "sequence": 130000.0,
  "group": "unstarted",
  "default": false,
  "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "project": "4af68566-94a4-4eb3-94aa-50dc9427067b",
  "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4"
}