Plans
Get a spec’s outline: headings, open questions and criteria with their lines
Authorization
bearerAuth AuthorizationBearer <token>
A personal API key (psk_…) or an OAuth access token (plan_at_…). Scopes: read, write.
In: header
Path Parameters
projectSlug*string
Project slug, e.g. recipe-box.
planShortId*string
Plan handle within the project, e.g. PLAN-12.
specShortId*string
Spec handle within the plan, e.g. SPEC-3 — or the tracker key of a linked spec, e.g. SIT-123.
Query Parameters
section?string
Not accepted here: ask for the outline or for one section (GET …/specs/{specShortId}?section=), not both. Sending it is a 400 with details.code BOTH_READ_MODES.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/projects/string/plans/string/specs/string/outline"{ "revision": "string", "lines": 0, "headings": [ { "level": 0, "text": "string", "line": 0, "endLine": 0, "chars": 0 } ], "openQuestions": { "live": [ { "handle": "string", "line": 0, "text": "string" } ], "decided": 0 }, "acceptanceCriteria": { "count": 0, "items": [ { "id": "string", "line": 0 } ] }, "omitted": [ "string" ]}