v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Documents

List document drafts

Lists drafts for a document with branch context. By default only active drafts are returned; pass include=archived to also include soft-deleted drafts (retained ~7 days). Results are sorted by createdAt descending.

get/api/v1/documents/{identifier}/drafts

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Document identifier (either document ID or identifier slug)

Query parameters

includestring

Comma-separated list of additional drafts to include. Only "archived" is recognized — when present, soft-deleted drafts (retained ~7 days) are returned alongside active drafts.

Example:archived

Comma-separated list of additional drafts to include. Only "archived" is recognized — when present, soft-deleted drafts (retained ~7 days) are returned alongside active drafts.

Response

List of drafts for the document

createdAtstring date-time required

When the draft was created

draftOutOfDateboolean required

True when the published document was published more recently than the draft was created (the draft is based on a stale baseline)

identifierstring required

Draft workbook identifier — use this to address the draft

publishedIdentifierstring required

Identifier of the published document the draft is for

status'active' | 'archived' required

Lifecycle status: "active" for current drafts, "archived" for soft-deleted drafts (retained ~7 days)

updatedAtstring date-time required

Most recent edit time on the draft workbook

workbookModelIdstring uuid required

omni_model ID for the draft workbook