SpecifyDocs

Document view

/v1/documents/{id}/view

Signed-in sessionLaunch key product.editorOperation document_view

People plan work as projects with tasks, sprints, a board, a backlog, a timeline and a dashboard, and write shared documents in one editor with history and media.

Path parameters

idstringRequired

Query parameters

expectedAuthorizationVersionstring
documentFormat2

Returns

documentobjectRequired
headJsonstringRequired
minAvailableVersionnumberRequired
archivedbooleanRequired
authorizationVersionstringRequired
permissionGenerationnumberRequired
canEditbooleanRequired

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}. A call without a valid credential gets 401 before its input is checked, and so does an address that is not an operation: 404 and 400 come only once the credential is accepted. Public operations answer without one.