Skip to content

Get a project label ​

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

Retrieve one project label by id.

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 project label to retrieve.

Response shaping ​

fields:optionalstring

Comma-separated list of fields to return. 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 ​

StatusCodeCause
401unauthorizedMissing or invalid credentials.
403forbiddenYour role or token scope can't read project labels.
404not_foundNo such project label or workspace, 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.
Get a project label
bash
curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/project-labels/d8a4f2c6-1e7b-4093-9c5a-6b2e0f8d3a71/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "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
}
Response404
json
{
  "type": "not_found",
  "code": "not_found",
  "detail": "The requested resource was not found."
}