Skip to content

Overview ​

Labels are tags that help you categorize and organize work items in your project.

Learn more about labels

The label object ​

Attributes ​

  • name string (required)

    Name of the label

  • created_at , updated_at timestamp

    When the label was created and last updated.

  • description string

    Description of the label

  • color string

    Display color as a hex code

  • sort_order float

    Position used for manual ordering

  • created_by & updated_by

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

  • project uuid

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

  • workspace uuid

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

  • parent uuid or null

    ID of the parent label, which is itself a label

Response200
json
{
  "id": "c7146baf-7058-496b-aa3a-df6c25a7e929",
  "created_at": "2023-11-20T06:01:03.538675Z",
  "updated_at": "2023-11-20T06:01:03.538683Z",
  "name": "High",
  "description": "",
  "color": "",
  "sort_order": 72416.0,
  "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",
  "parent": null
}