List a release's labels

GET/api/v2/workspaces/{slug}/releases/{pk}/labels/

Return the labels applied to a workspace release as full release label objects, paginated. The release's label_ids field holds only the ids. This list returns each label's name, color, and sort order in the same call.

The list takes no filters and no order_by. Rows come back ordered by the label's created_at, newest first. An empty list means the release has no labels, not that the release is missing.

This route serves workspace releases only. A project release, a release you can't view, and an unknown id all return 404. For a project release, use List a project release's labels. To add or remove labels, use Add or remove release labels.

Path parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

pk:requiredstring (uuid)

The id of the release whose labels you want.

Pagination

per_page:optionalinteger

Page size. Defaults to 50, maximum 200.

offset:optionalinteger

Number of rows to skip from the start of the result set. Maximum 10000. Use the next value from the response instead of computing offsets yourself.

count:optionalboolean

Defaults to true. Set to false to skip the COUNT(*) behind total_count. The field is then left out of the response.

Response shaping

fields:optionalstring

Comma-separated list of label fields to return on each row. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.

Pass all to get every requestable field. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.

Requestable here: color, created_at, created_by_id, id, name, sort_order, updated_at, updated_by_id.

See Sparse fields.

Scopes

releases:read

Errors

Status	Code	Cause
400	invalid_request	A ?fields= name, per_page, or offset failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Releases aren't enabled on your plan.
403	forbidden	Your token scope doesn't allow this.
404	not_found	No workspace release with this id, the id belongs to a project release, or you can't view the release.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

List a release's labels

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/releases/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/labels/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/releases/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/labels/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/releases/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/labels/",
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "data": [
    {
      "id": "0e6b4d83-1a7c-4f29-b8e5-3c2a9f7d1b60",
      "name": "Hotfix",
      "color": "#e5484d",
      "sort_order": 1,
      "created_at": "2026-01-12T15:40:09.871226Z",
      "updated_at": "2026-01-12T15:40:09.871226Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    },
    {
      "id": "7f3a2c19-8e4d-4b61-a5c7-2d9e0f1b8a46",
      "name": "Mobile",
      "color": "#3f76ff",
      "sort_order": 0,
      "created_at": "2026-01-10T11:02:18.304551Z",
      "updated_at": "2026-01-10T11:02:18.304551Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "The requested resource was not found."
}