Plans
Export a plan as markdown, CSV, JSON, or the pull index
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.
Query Parameters
format?string
Defaults to md. Markdown and CSV come back as a file download. index is what plansmith plan pull saves: every spec with its content, a revision hash of what it writes, its acceptance criteria as data (id, text, checked, and body, the lines under the criterion) and its heading outline; plus the epic and a plan revision. format in the answer names the shape (plansmith.plan-pull/1).
Value in
- "md"
- "markdown"
- "csv"
- "json"
- "index"
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/projects/string/plans/string/export"{ "name": "string", "specs": [ { "id": "string", "shortId": "string", "trackerKey": "string", "kind": "spec", "title": "string", "content": "string", "revision": "string", "status": "string", "parentSpecId": "string", "parentShortId": "string", "needsFirst": [ "string" ], "effort": 1, "effortLabel": "string", "readiness": 1, "readinessLabel": "string", "readinessHold": { "source": "checklist", "criteria": [ "string" ], "reasons": [ "string" ] }, "readinessReasons": [ "string" ], "openQuestions": { "open": 0, "resolved": 0 } } ]}