Read a workflow

GEThttps://<your-url>/api/v2/workflows/{workflow}

MCP id workflows.showAlso on this path: PATCH Update a workflow, DELETE Delete a workflow

Returns one workflow.

Token scope: api:read:workflows
Without it: 403 insufficient-token-scope.
Permission: workflows::read
Without it: 403 insufficient-permission.
Feature: Needs the sprints feature on your organisation.
Without it: 404 endpoint-not-found.
Rate cost: 1 unit, read bucket.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: One workflow

curl -X GET \
  'https://<your-url>/api/v2/workflows/1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/workflows/1', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/workflows/1');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/workflows/1',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "name": "Bug triage",
    "order": 1,
    "created_at": "2026-03-04T09:15:00Z",
    "updated_at": "2026-03-04T09:15:00Z",
    "statuses_count": 1,
    "links": {
      "self": "https://<your-url>/api/v2/work-items/1",
      "statuses": "https://<your-url>/api/v2/work-items/1"
    }
  }
}

The summary and detail views are identical on this resource: every field is small enough for a list row, and nothing is includable, so include is rejected. Read the workflow's statuses through links.statuses, and its transitions through GET /api/v2/workflow-transitions?filter[workflow_id]={id}.

Path parameters

workflowintegerRequired

The Workflow's numeric id.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a Workflow in the detail view.

Headers

ETag: A strong validator of exactly this representation.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning