SnozeDevelopers
API referenceCanvas

List the elements on a canvas surface

Returns canvas elements and their workspace version. Optional limit (1–2000) bounds the database read and returns hasMore; omitted limit returns the full scene for editors. Requires `canvas:read` on the surface. Returns a not-found error when the workspace has no surface with that id.

GET
/v1/workspaces/{workspaceId}/surfaces/{surfaceId}/canvas/elements

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Path Parameters

workspaceId*string
surfaceId*string

Query Parameters

limit?string|null

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.snoze.dev/v1/workspaces/string/surfaces/string/canvas/elements'
Example Response
{  "data": {    "surfaceId": "string",    "workspaceVersion": 0,    "elements": [      {        "id": "string",        "workspaceId": "string",        "surfaceId": "string",        "type": "rectangle",        "x": 0,        "y": 0,        "w": 0,        "h": 0,        "angle": 0,        "version": 0,        "versionNonce": 0,        "index": "string",        "isDeleted": true,        "props": {},        "createdAt": "string",        "updatedAt": "string"      }    ],    "hasMore": true  }}