List workspace workflows

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

Return the catalog workflows of a governed workspace as a paginated list. Each row carries the workflow's metadata and three counts: states_count, projects_count, and work_item_types_count.

The chain is not on the row. Use Get a workspace workflow for states, referenced_resources, project_ids, and work_item_type_ids. Project workflows never appear in this list, and in an ungoverned workspace it returns 409 states_managed_at_project.

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.

name:optionalstring

Return the workflow with this name. The match is exact but case-insensitive, so delivery finds Delivery.

is_active:optionalboolean

Return only active (true) or only inactive (false) workflows. A new workflow stays inactive until you activate it.

is_default:optionalboolean

Return only the workspace default workflow (true) or every other workflow (false).

search:optionalstring

A search term matched against the name and the description.

Ordering

order_by:optionalstring

Field to sort by. Prefix with - for descending.

• created_at, -created_at: when each workflow was created. -created_at is the default.
• name, -name
• updated_at, -updated_at
• id, -id

Only created_at and id are cursor-eligible. Pairing paginate=cursor with order_by=name or order_by=updated_at returns 400 ordering_not_cursor_eligible.

Pagination

per_page:optionalinteger

Page size. Defaults to 50, maximum 200. Most workspaces have a handful of catalog workflows, so one page is usually all of them.

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: created_at, created_by_id, description, id, is_active, is_default, name, projects_count, states_count, updated_at, updated_by_id, work_item_types_count.

The detail-only fields states, referenced_resources, project_ids, and work_item_type_ids aren't requestable on the list. Naming one is a 400.

See Sparse fields.

Scopes

workspaces.workflows:read

Errors

Status	Code	Cause
400	invalid_request	An unknown or detail-only name in fields, or a malformed filter value.
400	ordering_not_cursor_eligible	paginate=cursor with an order_by that isn't cursor-eligible.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The OpenAPI schema declares 402 for every catalog route. This endpoint checks no plan feature, so it never returns 402.
403	forbidden	Your role or token scope can't view workspace workflows.
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.
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 workflows

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/workflows/?is_active=true&per_page=50" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

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

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

Response200

{
  "data": [
    {
      "id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
      "name": "Delivery",
      "description": "Engineering delivery flow with a review gate",
      "is_active": true,
      "is_default": false,
      "states_count": 4,
      "projects_count": 2,
      "work_item_types_count": 1,
      "created_at": "2026-01-14T09:22:41.478363Z",
      "updated_at": "2026-01-15T11:04:52.660219Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    },
    {
      "id": "3e8a5d21-7b4c-4f19-a6e2-0d9c8b7f5a14",
      "name": "Standard",
      "description": "Workspace default workflow",
      "is_active": true,
      "is_default": true,
      "states_count": 5,
      "projects_count": 14,
      "work_item_types_count": 3,
      "created_at": "2025-11-02T08:15:27.331846Z",
      "updated_at": "2025-11-02T08:15:27.331846Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}

Response409

{
  "type": "conflict",
  "code": "states_managed_at_project",
  "detail": "Workflows are managed at the project level in this workspace."
}