SpecifyDocs

Canvas open

/v1/canvases/{id}/open

Signed-in sessionLaunch key product.canvasOperation canvas_open

A canvas is a drawing in the workspace or a page in a project's Docs tree.

Path parameters

idstringRequired

Body

mode"edit" | "view"
expectedAuthorizationVersionstring

Returns

canvasobjectRequired
leaseobjectRequired
checkpointnull | objectRequired
rowsobject[]Required
nextCursornull | stringRequired

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.