Gnoll Docs Back to Dashboard
Quick Start
Getting Started

Labels API

Create, manage, and assign labels to issues. Labels support categories for structured grouping.

List Labels

GET /api/v1/labels

Query Parameters

ParameterTypeDescription
categorystringFilter by category. Use _uncategorized for labels without a category.

Example Response

{
  "items": [
    {
      "id": 1,
      "name": "frontend",
      "color": "#4ade80",
      "category": "area",
      "sortOrder": 0
    }
  ]
}

List Categories

GET /api/v1/labels/categories

Returns a list of distinct category names in use.

Create Label

POST /api/v1/labels
{
  "name": "needs-review",
  "color": "#facc15",
  "category": "state",
  "sortOrder": 1
}
FieldRequiredDescription
nameYesLabel name (1-50 chars, unique within category)
colorYesHex color (e.g., #ff4444)
categoryNoCategory name (1-50 chars, alphanumeric + hyphens)
sortOrderNoDisplay order within category (default: 0)

Update Label

PATCH /api/v1/labels/{id}

Partial update — send only the fields to change.

Delete Label

DELETE /api/v1/labels/{id}

Issue Labels

GET /api/v1/labels/issue/{issueId}

Returns labels attached to a specific issue, grouped by category.

POST /api/v1/labels/issue/{issueId}/{labelId}

Attaches a label to an issue.

DELETE /api/v1/labels/issue/{issueId}/{labelId}

Removes a label from an issue.

Scopes Required

ActionScope
List/view labelslabels:read
Create/update/delete labelslabels:write
Attach/detach labels to issueslabels:write