v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB

Documents

List document drafts

<Note> This endpoint requires **Viewer** permissions or higher on the specified document. </Note>

List all drafts attached to a published document. A document in Omni can have up to one draft per branch plus one draft not attached to a branch.

By default, returns active drafts only. Pass ?include=archived to include soft-deleted drafts retained for approximately 7 days.

get/v1/documents/{documentId}/drafts

Path parameters

identifierstring required

The identifier of the published document. To retrieve the ID, navigate to File > Document settings in the document and then click Settings. The Identifier field contains the document ID.

Query parameters

include'archived'

Pass archived to include soft-deleted drafts in the response. By default, only active drafts are returned.

Response

List of drafts retrieved successfully. Results are sorted in descending order using the draft's updatedAt.

identifierstring

The identifier of the draft.

publishedIdentifierstring

The identifier of the published document this draft is attached to.

workbookModelIdstring uuid

The UUID of the workbook model.

status'active' | 'archived'

The status of the draft.

draftOutOfDateboolean

Indicates whether the draft is out of date compared to the published document.

createdAtstring date-time

Timestamp when the draft was created.

updatedAtstring date-time

Timestamp when the draft was last updated.

Example response

[
  {
    "identifier": "d56b7f56",
    "publishedIdentifier": "ecd01fe5",
    "workbookModelId": "d61034e2-05fe-4268-a3a7-d4cdb8d650e9",
    "branch": {
      "id": "a9bc51d2-1234-5678-9abc-def012345678",
      "name": "governance/relabel-age-average"
    },
    "status": "active",
    "createdAt": "2026-05-06T13:44:00.000Z",
    "updatedAt": "2026-05-06T13:44:26.000Z",
    "createdBy": {
      "name": "Blob Ross"
    },
    "lastEditedBy": {
      "name": "Blob Ross"
    }
  }
]