Skip to content

List a project release's labels ​

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

Return the labels applied to a project release as full release label objects, paginated. The release's label_ids gives you only the ids. This list gives you 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.

To add or remove labels, use Add or remove project 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.

project_id:requiredstring

The project the release belongs to. Accepts the project UUID or its bare identifier, for example ENG.

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. Read the next value from the response rather than 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. Unrequested keys are omitted from the response, not returned as null, so absent means "not requested" and null means "actually null". id always comes back whether or not you name it.

Pass all for every requestable field. An unknown name is a 400 that lists the valid set and suggests the closest match, so a typo can't silently cost you the saving.

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

See Sparse fields.

Scopes ​

releases:read

Errors ​

StatusCodeCause
401unauthorizedMissing or invalid credentials.
402payment_requiredProject releases aren't enabled on your plan.
403forbiddenYour token scope doesn't allow this.
404not_foundNo release with this id in this project, or no such workspace or project.
406not_acceptableThe Accept header asks for a representation the API can't produce.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
List a project release's labels
bash
curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/labels/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "data": [
    {
      "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": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 1,
  "pagination": {
    "style": "offset"
  }
}