SpedySpedy Docs

Labels

Create and manage labels for categorizing tickets.

Labels provide a flexible way to categorize and filter tickets across boards. Each label has a name, color, and optional description.

List Labels

GET /api/v1/labels

Returns all labels in the organization.

Example Response

[
  {
    "id": "lbl_abc123",
    "name": "Frontend",
    "color": "#3B82F6",
    "description": "Frontend-related work",
    "createdAt": "2025-01-15T10:00:00Z"
  },
  {
    "id": "lbl_def456",
    "name": "Urgent",
    "color": "#EF4444",
    "description": null,
    "createdAt": "2025-01-15T10:00:00Z"
  }
]

Create Label

POST /api/v1/labels

Permission required: settings:edit

Request Body

FieldTypeRequiredDescription
namestringYesLabel name (max 50 characters)
colorstringYesColor in hex format (e.g. #3B82F6)
descriptionstringNoLabel description (max 200 characters)

Example Request

{
  "name": "Frontend",
  "color": "#3B82F6",
  "description": "Frontend-related work"
}

Get Label

GET /api/v1/labels/{labelId}

Returns a single label.

Update Label

PATCH /api/v1/labels/{labelId}

Permission required: settings:edit

Request Body

FieldTypeRequiredDescription
namestringNoLabel name
colorstringNoColor in hex format
descriptionstringNoLabel description

Delete Label

DELETE /api/v1/labels/{labelId}

Permission required: settings:edit

Permanently deletes the label and removes it from all tickets. Returns 204 No Content.