Skip to content
calternal docs

Read a public Canvas

GET
/api/v1/public/{slug}/canvas
curl --request GET \
  --url https://example.com/api/v1/public/example/canvas

Return a passive Canvas projection under a current public view grant. Private linked items and file references are removed. Route: /api/v1/public/{slug}/canvas. Inputs: slug. Safe reads can use bounded retries.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
Examplegenerated
example

304

Section titled “304”

Drawing unchanged

404

Section titled “404”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

429

Section titled “429”

Too many requests

Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}