Get a workspace workflow state

GET/api/v2/workspaces/{slug}/workflows/{workflow_id}/states/{state_id}/

Retrieve one entry in a catalog workflow's chain, addressed by its catalog state id. Use it to check a state's type, its default flag, or whether new work items can be created in it.

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.

workflow_id:requiredstring (uuid)

The catalog workflow whose chain you are working with.

state_id:requiredstring (uuid)

The catalog state id, not the chain entry's own id. A state that isn't in this workflow's chain returns 404.

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: allow_issue_creation, id, is_default, sequence, state_id, type, updated_at, workflow_id.

See Sparse fields.

Scopes

workspaces.workflows:read

Errors

Status	Code	Cause
400	invalid_request	An unknown name in fields.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Workflows isn't on your plan, or is switched off.
403	forbidden	Your role or token scope can't view workspace workflows.
404	not_found	No such workflow in this workspace's catalog, or the state isn't in its chain.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	states_managed_at_project	The workspace doesn't have governance turned on. Use the project's workflows instead.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Get a workspace workflow state

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/states/b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/states/b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/states/b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53/",
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "id": "c48f1a6d-2e7b-4d95-8c03-6b1e9f2a7d54",
  "state_id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "workflow_id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
  "type": "approval",
  "is_default": false,
  "allow_issue_creation": false,
  "sequence": 30000.0,
  "updated_at": "2026-01-14T09:31:07.215904Z"
}

Response404

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