List states

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

Return the states in a project as a paginated list. Use it to resolve a state name to the state_id you need when creating or moving a work item, or to build a state picker that stays in sync with the project's workflow.

Results are scoped to a single project. For a workspace-wide list, use Workspace states. In one call, it returns the states of every non-archived project you can see. In a workspace with governance turned on, it returns the shared catalog instead.

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.

project_id:requiredstring (uuid)

The project whose states you want to list.

Query parameters

Filters combine with AND. The enum-backed filters group and group__in are validated: an unrecognized value returns 400 invalid_request instead of an empty list, so a typo shows up immediately. order_by and paginate are not validated. An unrecognized order_by silently falls back to the default ordering, and any value other than paginate=cursor silently uses offset pagination, so check the spelling of those two.

name:optionalstring

Return states whose name matches this value, compared case-insensitively. Use it to resolve a state name such as In Progress to its id.

group:optionalstring

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

Use the group__in variant to match several groups at once, passing them comma-separated, for example ?group__in=started,completed. Filtering by group is the portable way to find which states count as in progress, because every project names its states differently but the groups are fixed.

is_default:optionalboolean

Return only the project's default state (true) or only the non-default states (false). Pairing ?is_default=true with ?per_page=1 is the cheapest way to find where new work items will land.

external_id:optionalstring

Return states whose external_id matches exactly. Use it to find the state you previously created for a record in another system.

external_source:optionalstring

Return states that came from a particular system, for example github or jira. Combine it with external_id, because an external_id is only unique 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.

• sequence , -sequence: the project's own workflow order
• created_at , -created_at: when each state was added
• id , -id

Order by sequence when you are rendering the workflow to a user; it is the order the project itself uses.

Pagination

per_page:optionalinteger

Page size. Defaults to 50, maximum 200. Most projects have fewer than 20 states, so one page is usually the whole workflow.

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, which skips the COUNT query and returns next_cursor and has_more instead of next and total_count. Leave it out to get 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. 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, sequence, updated_at, updated_by_id.

See Sparse fields.

Scopes

projects.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 role or token scope can't read this project's states.
404	not_found	No such workspace or project, 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 states

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/states/?order_by=sequence&per_page=50" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/states/",
    headers={"X-Api-Key": "your-api-key"},
    params={"order_by": "sequence", "per_page": 50},
)
print(response.json())

const params = new URLSearchParams({ order_by: "sequence", per_page: "50" });
const response = await fetch(
  `https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/states/?${params}`,
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "data": [
    {
      "id": "2c4d16f8-9b3e-4a52-8d71-1f0e6c9a5b48",
      "name": "Backlog",
      "description": "Not yet scheduled",
      "color": "#8b8d98",
      "group": "backlog",
      "sequence": 15000,
      "is_default": true,
      "is_triage": 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
    },
    {
      "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,
      "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
    },
    {
      "id": "7b1e9d40-3c86-4f2a-9a5d-8e2b0c47d613",
      "name": "Done",
      "description": "Shipped",
      "color": "#26a05f",
      "group": "completed",
      "sequence": 35000,
      "is_default": false,
      "is_triage": false,
      "external_id": null,
      "external_source": null,
      "created_at": "2026-01-14T09:22:41.548221Z",
      "updated_at": "2026-01-14T09:22:41.548221Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 3,
  "pagination": {
    "style": "offset"
  }
}

Response200

{
  "data": [
    {
      "id": "2c4d16f8-9b3e-4a52-8d71-1f0e6c9a5b48",
      "name": "Backlog",
      "description": "Not yet scheduled",
      "color": "#8b8d98",
      "group": "backlog",
      "sequence": 15000,
      "is_default": true,
      "is_triage": 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
    }
  ],
  "next_cursor": "b3A9MTcx",
  "has_more": true,
  "pagination": {
    "style": "cursor"
  }
}

Read the group, not the name

A project can rename In Progress to Building at any time, and reporting keeps working because boards and burndowns read group. Write integrations the same way: match on group, and treat name as a label for humans.