List workspace workflow states

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

Return the entries in a catalog workflow's chain as a paginated list, in chain order by default. Each row puts one catalog state (state_id) in the workflow and holds its settings there.

The list has no filters. A chain rarely has more than a page of states.

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.

Ordering

order_by:optionalstring

Field to sort by. Prefix with - for descending.

• sequence, -sequence: chain order. sequence is the default.
• created_at, -created_at: when each state was added to the chain.
• id, -id

Only created_at and id are cursor-eligible. The cursor path rejects the default sequence ordering with 400 ordering_not_cursor_eligible, so pair paginate=cursor with order_by=created_at.

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. Read the next value from the response rather than computing offsets yourself.

paginate:optionalstring

Set to cursor to opt into the COUNT-free keyset envelope, which returns next_cursor and has_more instead of next and total_count. Omit it for the default offset envelope.

count:optionalboolean

Defaults to true. Set to false to skip the COUNT(*) behind total_count. The field is then omitted from the response.

Response shaping

fields:optionalstring

Comma-separated list of fields to return on each row. 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.
400	ordering_not_cursor_eligible	paginate=cursor with an order_by that isn't cursor-eligible, including the default.
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 it's outside your tenant.
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.

List workspace workflow states

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/states/?order_by=sequence" \
  -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/",
    headers={"X-Api-Key": "your-api-key"},
    params={
        "order_by": "sequence",
    },
)
print(response.json())

const params = new URLSearchParams({
  order_by: "sequence",
});
const response = await fetch(
  `https://api.plane.so/api/v2/workspaces/my-team/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/states/?${params}`,
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "data": [
    {
      "id": "5a7c2e19-8d3f-4b61-9e0a-2f4d6c8b1a37",
      "state_id": "2c4d16f8-9b3e-4a52-8d71-1f0e6c9a5b48",
      "workflow_id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
      "type": "transition",
      "is_default": true,
      "allow_issue_creation": true,
      "sequence": 10000.0,
      "updated_at": "2026-01-14T09:31:07.215904Z"
    },
    {
      "id": "0e6b4d82-1c9a-4f53-b7e2-9a3d5f8c6e10",
      "state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
      "workflow_id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
      "type": "transition",
      "is_default": false,
      "allow_issue_creation": true,
      "sequence": 20000.0,
      "updated_at": "2026-01-14T09:31:07.215904Z"
    },
    {
      "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"
    },
    {
      "id": "61d9b3f7-4a2c-4e86-9f15-3c7a0e8d2b96",
      "state_id": "7b1e9d40-3c86-4f2a-9a5d-8e2b0c47d613",
      "workflow_id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
      "type": "transition",
      "is_default": false,
      "allow_issue_creation": false,
      "sequence": 40000.0,
      "updated_at": "2026-01-14T09:31:07.215904Z"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 4,
  "pagination": {
    "style": "offset"
  }
}