Skip to content

List workspace workflow transitions ​

GET/api/v2/workspaces/{slug}/workflows/{workflow_id}/state-transitions/

Return the transitions of a catalog workflow as a paginated list, across every state in the chain, oldest first. Each row is one allowed move from a chain state to a target state.

A row names its source by workflow_state_id, the chain entry's id, not the catalog state id. Read List workspace workflow states to map chain entries to catalog 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 the transitions belong to.

Ordering ​

order_by:optionalstring

Field to sort by. Prefix with - for descending.

  • created_at, -created_at: when each transition was created. created_at is the default.
  • 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, 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: created_at, id, member_ids, rejection_state_id, required_approvals, transition_state_id, updated_at, workflow_state_id.

See Sparse fields.

Scopes ​

workspaces.workflows:read

Errors ​

StatusCodeCause
400invalid_requestAn unknown name in fields.
401unauthorizedMissing or invalid credentials.
402payment_requiredThe Workflows feature isn't on your plan, or is turned off.
403forbiddenYour role or token scope can't view workspace workflows.
404not_foundNo such workflow in this workspace's catalog, or it's outside your tenant.
406not_acceptableThe Accept header asks for a representation the API can't produce.
409states_managed_at_projectThe workspace doesn't have governance turned on. Use the project's workflows instead.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
List workspace workflow transitions
bash
curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/state-transitions/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "data": [
    {
      "id": "8d2f6a41-5c3e-4b97-a1d0-7e9c4b2f8a63",
      "workflow_state_id": "5a7c2e19-8d3f-4b61-9e0a-2f4d6c8b1a37",
      "transition_state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
      "rejection_state_id": null,
      "required_approvals": null,
      "member_ids": [],
      "created_at": "2026-01-14T09:31:07.215904Z",
      "updated_at": "2026-01-14T09:31:07.215904Z"
    },
    {
      "id": "d7a3f5c9-0b2e-4d81-b6f4-9e1c3a5d7b20",
      "workflow_state_id": "0e6b4d82-1c9a-4f53-b7e2-9a3d5f8c6e10",
      "transition_state_id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
      "rejection_state_id": null,
      "required_approvals": null,
      "member_ids": [],
      "created_at": "2026-01-14T09:31:07.215904Z",
      "updated_at": "2026-01-14T09:31:07.215904Z"
    },
    {
      "id": "4b6e1d93-2a7f-4c58-9e30-1d8b5f7a2c46",
      "workflow_state_id": "c48f1a6d-2e7b-4d95-8c03-6b1e9f2a7d54",
      "transition_state_id": "7b1e9d40-3c86-4f2a-9a5d-8e2b0c47d613",
      "rejection_state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
      "required_approvals": 1,
      "member_ids": ["a3f92c71-6e4b-4d08-9b5a-1c7e3d9f2b84"],
      "created_at": "2026-01-15T11:04:52.660219Z",
      "updated_at": "2026-01-15T11:04:52.660219Z"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 3,
  "pagination": {
    "style": "offset"
  }
}