List project states

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

Return the workspace's project states as a paginated list. Use it to resolve a stage name such as Execution to the id you send as a project's state_id.

These are the stages a project moves through, not work item states. For work item states, see List workspace 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.

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 project states whose name matches this value, compared case-insensitively. Name uniqueness is case-sensitive, so Discovery and discovery can both exist, and this filter returns both.

group:optionalstring

Return only project states in this lifecycle group. One of draft, planning, execution, monitoring, completed, or cancelled.

Use group__in to match several groups at once, comma-separated: ?group__in=execution,monitoring.

is_default:optionalboolean

Return only the default project state (true) or only the others (false).

external_id:optionalstring

Return project states whose external_id matches exactly.

external_source:optionalstring

Return project states that came from a particular system. Combine it with external_id.

search:optionalstring

A search term matched against the project state name.

Ordering

order_by:optionalstring

Field to sort by. Prefix with - for descending. Defaults to sequence, the lifecycle order.

• 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, name, sequence, updated_at, updated_by_id.

See Sparse fields.

Scopes

workspaces.project_states:read

Errors

Status	Code	Cause
400	invalid_request	A group, group__in, or is_default 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.
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 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 project states

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/project-states/?order_by=sequence&per_page=3" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

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

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

Response200

{
  "data": [
    {
      "id": "3c7a1e92-5d4b-4f08-9a6e-2b8d0c5f7e14",
      "name": "Draft",
      "description": "",
      "color": "#60646C",
      "group": "draft",
      "sequence": 15000,
      "is_default": true,
      "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": "a41d6f38-0e2c-4b97-85a3-7f1e9d2c6b50",
      "name": "Planning",
      "description": "",
      "color": "#60646C",
      "group": "planning",
      "sequence": 25000,
      "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
    },
    {
      "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
    }
  ],
  "next": 3,
  "previous": null,
  "total_count": 6,
  "pagination": {
    "style": "offset"
  }
}

Response402

{
  "type": "payment_required",
  "code": "payment_required",
  "detail": "Project grouping is not enabled for this workspace."
}