Skip to content

List an initiative's labels ​

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

Return the labels applied to one initiative as full label objects, paginated. The initiative's label_ids field holds only the ids. This list returns the names and colors behind them in one call.

This list is not the label catalog. For the workspace's full set of initiative labels, applied or not, use List initiative labels.

An initiative you can't see returns 404. Seeing the initiative is enough to see its labels.

To change the labels on the initiative, POST to the same path, as described in Add or remove initiative labels. The list takes no filters and no search.

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 initiative whose labels you want to list.

Ordering ​

Rows come back in a fixed order, newest first by each label's created_at, with id as the tiebreaker. This order ignores each label's sort_order. Sort by sort_order on your side to match the order the catalog uses. An order_by you send is ignored.

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 omitted from the response.

Response shaping ​

fields:optionalstring

Comma-separated list of 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, description, id, name, sort_order, updated_at, updated_by_id.

See Sparse fields.

Scopes ​

initiatives:read

Errors ​

StatusCodeCause
400invalid_requestAn unknown name in fields.
401unauthorizedMissing or invalid credentials.
403forbiddenYour role or token scope doesn't allow this.
404not_foundNo such initiative, you can't see it, or it's outside your tenant.
406not_acceptableThe Accept header asks for a representation the API can't produce.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
List an initiative's labels
bash
curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/initiatives/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/labels/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "data": [
    {
      "id": "6e1d9b47-3a28-4f5c-8b70-2c9e4a1f7d35",
      "name": "Strategic",
      "description": "Board-level priority for the year",
      "color": "#8b5cf6",
      "sort_order": 65535.0,
      "created_at": "2026-01-08T10:12:33.204871Z",
      "updated_at": "2026-01-08T10:12:33.204871Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    },
    {
      "id": "b3f04c6a-91d2-4e87-a5b3-7d0e2f8c4a19",
      "name": "Q1",
      "description": "",
      "color": "#26a05f",
      "sort_order": 131070.0,
      "created_at": "2026-01-02T15:47:19.665302Z",
      "updated_at": "2026-01-02T15:47:19.665302Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}