Create a workflow

POST/api/v2/workspaces/{slug}/projects/{project_id}/workflows/

Workflows constrain how work items move between states in a project. Create a workflow.

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

The project the resource belongs to. Accepts the project UUID or its bare identifier, for example ENG.

Body Parameters

name:requiredstring

Display name.

Maximum 255 characters.

description:optionalstring

Free-form description.

Nullable.

is_active:optionalboolean

Whether the record is active.

work_item_type_ids:optionalarray of string (uuid)

Ids of the work item types to associate. Replaces the current set.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.

Requestable here: created_at, created_by_id, description, id, is_active, is_default, name, updated_at, updated_by_id, work_item_type_ids.

Scopes

projects.workflows:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The Multiple workflows feature isn't on your plan, or is turned off.
403	forbidden	Your role or token scope doesn't allow this.
404	not_found	No such resource, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	governance_migration_in_progress	A governance migration is running in this workspace, so writes are paused. Retry after it finishes.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Create a workflow

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/workflows/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example name",
  "description": "What this is for.",
  "is_active": true,
  "work_item_type_ids": ["d1e7a4c9-2b58-4f36-9a0e-7c3b5d81f240"]
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/workflows/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "name": "Example name",
        "description": "What this is for.",
        "is_active": True,
        "work_item_type_ids": ["d1e7a4c9-2b58-4f36-9a0e-7c3b5d81f240"]
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/workflows/",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Example name",
      description: "What this is for.",
      is_active: true,
      work_item_type_ids: ["d1e7a4c9-2b58-4f36-9a0e-7c3b5d81f240"],
    }),
  },
);
const data = await response.json();

Response201

{
  "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,
  "description": "What this is for.",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_active": true,
  "is_default": false,
  "name": "Example name",
  "work_item_type_ids": ["d1e7a4c9-2b58-4f36-9a0e-7c3b5d81f240"]
}