Get a work item type workflow

GET/api/v2/workspaces/{slug}/projects/{project_id}/work-item-types/{type_id}/workflow/

Retrieve the work item type workflow entry for one type in a project. It names the catalog workflow that applies now, where it came from, and the workflows the project may pick 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

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

type_id:requiredstring (uuid)

The work item type. It must be active on the workspace and in this project, or the request returns 404.

Scopes

projects.workflows: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 view this project.
404	not_found	No such project, or the work item type isn't active in this project.
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, so the project owns its workflows.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Get a work item type workflow

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-item-types/d1e7a4c9-2b58-4f36-9a0e-7c3b5d81f240/workflow/" \
  -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"
    "/work-item-types/d1e7a4c9-2b58-4f36-9a0e-7c3b5d81f240/workflow/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b" +
    "/work-item-types/d1e7a4c9-2b58-4f36-9a0e-7c3b5d81f240/workflow/",
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "type_id": "d1e7a4c9-2b58-4f36-9a0e-7c3b5d81f240",
  "governance": "pinned",
  "allowlist_count": 0,
  "allowlist_total": 3,
  "effective_workflow_id": "e6b2d9f1-48a7-4c3e-9f50-1d7a8c2b6e93",
  "effective_workflow_name": null,
  "source": "pin",
  "options": []
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "Work item type not found or inactive."
}