Get a workspace state

GET/api/v2/workspaces/{slug}/states/{pk}/

Retrieve one state by id through the workspace-level route.

• In a governed workspace, pk must be a catalog state.
• In an ungoverned workspace, pk can be the state of any non-archived project you can see. The response carries that state's project_id.

The triage state returns 404 in both modes.

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 state to retrieve.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. 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, description, external_id, external_source, group, id, is_default, is_triage, name, project_id, sequence, updated_at, updated_by_id.

See Sparse fields.

Scopes

workspaces.states:read

Errors

Status	Code	Cause
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan, or is switched off.
403	forbidden	Your token scope can't read workspace states, or the workspace is governed and you are a guest.
404	not_found	No such state or workspace, the state is the triage state, or its project is archived or hidden from you.
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.

Get a workspace state

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/states/5a9e2c71-1f3b-4d86-a0c4-7e2b9d5f8a13/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/states/5a9e2c71-1f3b-4d86-a0c4-7e2b9d5f8a13/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/states/5a9e2c71-1f3b-4d86-a0c4-7e2b9d5f8a13/",
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "id": "5a9e2c71-1f3b-4d86-a0c4-7e2b9d5f8a13",
  "name": "In Progress",
  "description": "Actively being worked on",
  "color": "#3f76ff",
  "group": "started",
  "sequence": 30000,
  "is_default": false,
  "is_triage": false,
  "project_id": null,
  "external_id": null,
  "external_source": null,
  "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": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
}

Response404

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