Get review state

Read a document's approval state (draft, in_review, approved, changes_requested), the revision it applies to, and recent review decisions with their notes. On a document without approvals it returns enabled: false rather than an error. Members only.

post/api/v1/get_review_state

Request

  • Base URL: https://offprint.io
  • URL: https://offprint.io/api/v1/get_review_state
  • Auth: HTTP bearer

Request body

document_idstring uuid

The document's id, from publish_document or list_documents. Pass this or slug.

slugstring

The document's slug, e.g. 'roadmap-k3n8qz'. Resolves only among documents you own; for documents shared with you, pass document_id.

Response

Success.

enabledboolean required

False when approvals are not turned on for this document; state and revision are then null.

state'draft' | 'in_review' | 'approved' | 'changes_requested' nullable required

draft: not in review; in_review: waiting for reviewers; approved / changes_requested: the latest decision on that revision.

revisioninteger nullable required

The revision the state applies to.

head_revisioninteger required

The document's current revision.

notestring

Changes

No recorded changes to this operation across all 1 revision of this API.