Skip to content

Release labels overview ​

Release labels are the workspace-level label catalog for releases.

The release label object ​

Attributes ​

  • color string

    Hex color used wherever this is rendered, for example #3f76ff.

  • created_at string (date-time)

    When the record was created.

  • created_by_id string (uuid)

    The user who created the record.

  • id string (uuid)

    Unique identifier.

  • name string

    Display name.

  • sort_order integer

    Manual ordering weight. Lower sorts first.

Response200
json
{
  "color": "#3f76ff",
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "name": "Example name",
  "sort_order": 65535
}

Endpoints ​

MethodPathDescription
GET/api/v2/workspaces/{slug}/releases/labels/List release labels
GET/api/v2/workspaces/{slug}/releases/labels/{pk}/Get a release label
POST/api/v2/workspaces/{slug}/releases/labels/Create a release label
PATCH/api/v2/workspaces/{slug}/releases/labels/{pk}/Update a release label
DELETE/api/v2/workspaces/{slug}/releases/labels/{pk}/Delete a release label

Response shaping ​

Every release label read accepts ?fields= for sparse responses — see Sparse fields. Errors follow the shared problem+json contract.