Get Collab State
GET
/api/canvas/{deal_id}/collab-state
const url = 'https://example.com/api/canvas/example/collab-state';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/canvas/example/collab-state \ --header 'Authorization: Bearer <token>'Get the current collab state for a document.
Returns collab_enabled status, and if enabled, the current OT version and PM document JSON needed to initialize prosemirror-collab on the client.
Phase C2: RequireViewer — any collaborator can read collab state.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” deal_id
required
Deal Id
string
Responses
Section titled “ Responses ”Successful Response
Media type application/json
CollabStateResponse
Response for GET /api/canvas/{deal_id}/collab-state.
object
Example generated
{ "collab_enabled": true, "version": 1, "doc": {}}Validation Error
Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example", "input": "example", "ctx": {} } ]}