DocumentationTypeship CLITypeship MCPTypeship SDKsAPI Reference
Console
Drafts

List Drafts

GET
/drafts

Lists open and merged Drafts, newest first. Each Target has one open Draft; each merge adds a merged Draft.

Authorization

apiKey
AuthorizationBearer <token>

Organization API key from the console (ak_...), or an OAuth access token with user:org:read, the organization selected during consent, and the capability required by the operation.

In: header

Query Parameters

limit?integer

Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400 invalid_request. List query parameters must appear only once; unrecognized parameters also return 400.

Range1 <= value <= 100
Default20
cursor?string

Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty, malformed, or repeated cursors return 400 invalid_request. The page limit may change between requests.

Match^[A-Za-z0-9_-]+$
Length1 <= length <= 2048
target_id?string

Only Drafts of this Target.

Match^tgt_[a-z0-9]{16}$
status?string

Only Drafts with this status.

Value in

  • "none"
  • "working"
  • "action_required"
  • "ready"
  • "merged"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/drafts"
{  "object": "list",  "data": [    {      "id": "drf_3q7m1v8k2p5d9h4c",      "object": "draft",      "target_id": "tgt_5m8q2v7k1p9d4h6c",      "project_id": "prj_4k8m2v7q1p9d5h6c",      "status": "merged",      "version_next": "1.1.0",      "version_source": null,      "readiness": null,      "checks": [],      "changes": null,      "head_sha": "0123456789abcdef0123456789abcdef01234567",      "pull_request": {        "url": "https://github.com/parcel-example/parcel-client/pull/12",        "number": 12      },      "generation_id": null,      "release_id": "rel_7m2q8v4k1p9d5h6c",      "conflicts": null,      "customized_files": null,      "history_recovery": null,      "created_at": "2026-09-23T08:00:00Z",      "updated_at": "2026-09-24T10:00:00Z"    }  ],  "has_more": false,  "next_cursor": null,  "request_id": "req_3k8m1v6q9p2d7h4c"}

List a Spec Revision's files GET

Lists the captured source files and the resolved document Typeship generated from, ordered by path. Read content with getFile.

Get a Draft GET

Returns the Draft's status. An open Draft also reports its typed reason when action is required, next version and its source, readiness, checks, and conflict counts. The response carries an `ETag`; send it in `If-Match` when updating the Draft to avoid changing a newer version selection.