List workspace states

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

Return work item states at the workspace level as a paginated list. What you get depends on the workspace:

• With governance on, you get the workspace's catalog states. Every row has project_id: null.
• With governance off, you get the states of every non-archived project you can see, in one list. Each row carries its project_id.

The triage state is never returned. See Workspace states for how the two modes differ.

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.

Query parameters

Filters combine with AND. The API validates the enum filters group and group__in, so an unknown value returns 400 invalid_request instead of an empty list.

name:optionalstring

Return states with this exact name, compared case-insensitively. In an ungoverned workspace, several projects can each have a state with the same name.

group:optionalstring

Return only states in this workflow group. One of backlog, unstarted, started, completed, cancelled, or triage.

Use group__in to match several groups at once, comma-separated: ?group__in=started,completed. triage is accepted but never matches, because this route leaves out every state in the triage group.

project_id:optionalstring (uuid)

Return only the states of this project. It matches rows only in an ungoverned workspace, because catalog states have no project.

external_id:optionalstring

Return states whose external_id matches exactly.

external_source:optionalstring

Return states that came from a particular system, for example jira. Combine it with external_id, because an external_id is unique only within its source.

search:optionalstring

A search term matched against the state name.

Ordering

order_by:optionalstring

Field to sort by. Prefix with - for descending. Defaults to sequence.

• sequence, -sequence
• name, -name
• created_at, -created_at
• id, -id

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. Use the next value from the response instead of computing offsets yourself.

paginate:optionalstring

Set to cursor to switch to the keyset envelope (no COUNT query), which returns next_cursor and has_more instead of next and total_count. Cursor pagination needs order_by set to created_at, -created_at, id, or -id. Any other ordering, including the default sequence, returns 400 ordering_not_cursor_eligible.

count:optionalboolean

Defaults to true. Set to false to skip the COUNT(*) behind total_count. The response then omits total_count.

Response shaping

fields:optionalstring

Comma-separated list of fields to return on each row. 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, is_triage, name, project_id, sequence, updated_at, updated_by_id.

See Sparse fields.

Scopes

workspaces.states:read

Errors

Status	Code	Cause
400	invalid_request	A group, group__in, or project_id value failed validation.
400	ordering_not_cursor_eligible	?paginate=cursor with an ordering other than created_at or id.
401	unauthorized	Missing or invalid credentials.
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 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.

List workspace states

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/states/?group__in=started,completed&per_page=50" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/states/",
    headers={"X-Api-Key": "your-api-key"},
    params={"group__in": "started,completed", "per_page": 50},
)
print(response.json())

const params = new URLSearchParams({ group__in: "started,completed", per_page: "50" });
const response = await fetch(`https://api.plane.so/api/v2/workspaces/my-team/states/?${params}`, {
  headers: {
    "X-Api-Key": "your-api-key",
  },
});
const data = await response.json();

Response200

{
  "data": [
    {
      "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": null
    },
    {
      "id": "c83f1e04-6b2d-4a97-8e51-2f9a7c0d4b66",
      "name": "Done",
      "description": "Shipped",
      "color": "#26a05f",
      "group": "completed",
      "sequence": 45000,
      "is_default": false,
      "is_triage": false,
      "project_id": null,
      "external_id": null,
      "external_source": null,
      "created_at": "2026-01-14T09:22:41.512907Z",
      "updated_at": "2026-01-14T09:22:41.512907Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}

Response200

{
  "data": [
    {
      "id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
      "name": "In Progress",
      "description": "Actively being worked on",
      "color": "#3f76ff",
      "group": "started",
      "sequence": 25000,
      "is_default": false,
      "is_triage": false,
      "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
      "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
    },
    {
      "id": "1e7d4b90-3a6c-4f25-8b1e-9c2f5a0d7e63",
      "name": "In Progress",
      "description": "",
      "color": "#f5a623",
      "group": "started",
      "sequence": 25000,
      "is_default": false,
      "is_triage": false,
      "project_id": "8d2c5e7a-3b14-4f69-a2d8-6e0b9c1f4a35",
      "external_id": null,
      "external_source": null,
      "created_at": "2026-02-02T11:05:17.302114Z",
      "updated_at": "2026-02-02T11:05:17.302114Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}

Group the cross-project view by project_id

In an ungoverned workspace, each project has its own In Progress, with its own id. Use project_id to tell them apart, and send a work item the state id from its own project.