Get a project state

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

Retrieve one project state by id. Use it when you hold a project's state_id and need the stage's name, color, or group.

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 state 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, external_id, external_source, group, id, is_default, name, sequence, updated_at, updated_by_id.

See Sparse fields.

Scopes

workspaces.project_states:read

Errors

Status	Code	Cause
401	unauthorized	Missing or invalid credentials.
402	payment_required	Project states aren't included in the workspace's plan, or are turned off in its settings.
403	forbidden	Your role or token scope can't read project states.
404	not_found	No such project state or 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.

Get a project state

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/project-states/e2b95c07-8a3f-4d61-b7e4-0c6a1f9d3e28/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/project-states/e2b95c07-8a3f-4d61-b7e4-0c6a1f9d3e28/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/project-states/e2b95c07-8a3f-4d61-b7e4-0c6a1f9d3e28/",
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "id": "e2b95c07-8a3f-4d61-b7e4-0c6a1f9d3e28",
  "name": "Execution",
  "description": "",
  "color": "#F59E0B",
  "group": "execution",
  "sequence": 35000,
  "is_default": false,
  "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": null
}

Response404

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