List project labels

GET/api/v2/workspaces/{slug}/project-labels/

Return the workspace's project labels as a paginated list. These labels tag projects. For work item labels, see List 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.

Query parameters

Filters combine with AND.

name:optionalstring

Return labels with this name, compared case-insensitively. Create and update apply the same case-insensitive rule, so use this filter to check for a label before you create one.

name__in:optionalstring

Return labels whose name is in this comma-separated list: ?name__in=Roadmap,Platform. This match is case-sensitive.

search:optionalstring

A search term matched against the label name.

Ordering

order_by:optionalstring

Field to sort by. Prefix with - for descending. Defaults to sort_order.

• sort_order, -sort_order
• name, -name
• created_at, -created_at
• id, -id

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.

paginate:optionalstring

Set to cursor to switch to the keyset envelope (no COUNT query), which returns next_cursor and has_more instead of next and total_count. Cursor pagination needs order_by set to created_at, -created_at, id, or -id. Any other ordering, including the default sort_order, returns 400 ordering_not_cursor_eligible.

count:optionalboolean

Defaults to true. Set to false to skip the COUNT(*) behind total_count. The response then omits total_count.

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

workspaces.project_labels:read

Errors

Status	Code	Cause
400	ordering_not_cursor_eligible	?paginate=cursor with an ordering other than created_at or id.
401	unauthorized	Missing or invalid credentials.
403	forbidden	Your role or token scope can't read project labels.
404	not_found	No such workspace, or it's outside your tenant.
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 project labels

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/project-labels/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/project-labels/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json())

const response = await fetch("https://api.plane.so/api/v2/workspaces/my-team/project-labels/", {
  headers: {
    "X-Api-Key": "your-api-key",
  },
});
const data = await response.json();

Response200

{
  "data": [
    {
      "id": "d8a4f2c6-1e7b-4093-9c5a-6b2e0f8d3a71",
      "name": "Roadmap",
      "description": "Projects committed on this year's roadmap",
      "color": "#3e63dd",
      "sort_order": 65535,
      "created_at": "2026-01-14T09:22:41.478363Z",
      "updated_at": "2026-01-14T09:22:41.478363Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    },
    {
      "id": "2b6e9d14-7c3a-4f85-b0e2-9a1d5c8f6e37",
      "name": "Platform",
      "description": "",
      "color": "#12a594",
      "sort_order": 75535,
      "created_at": "2026-01-15T13:40:02.118204Z",
      "updated_at": "2026-01-15T13:40:02.118204Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}