---
title: "List canvas objects"
method: GET
path: "/v1/canvases/:canvas_key/objects"
---

# List canvas objects

`GET /v1/canvases/:canvas_key/objects`

List all objects in a canvas. The service account must have at least a viewer role for this canvas.

## Path parameters

- `canvas_key` string, required

## Query parameters

- `type` union
  - 'cell' — A cell
  - 'component' — A component
  - 'connector' — A connector between objects
  - 'ellipse' — An ellipse
  - 'embed' — An embed (video, bookmark, or iframe)
  - 'frame' — A frame
  - 'group' — A group of objects
  - 'image' — An image
  - 'line' — A line
  - 'pencil' — A freehand pencil drawing
  - 'polygon' — A polygon
  - 'rectangle' — A rectangle
  - 'stamp' — A stamp
  - 'thread' — A comment thread
  - 'text' — A text object
  - 'sticky_note' — A sticky note
- `connection_key` string

## Response `200`

Successful response

- object — Base response envelope for all successful API responses.
  - `success` true, required
  - `request_id` string, required
  - `result` object, required
    - `objects` CanvasObject[], required — The list of objects in the canvas.
      - `key` string, required — The unique identifier for an object in a canvas
      - `type` union, required — The type of canvas object
        - 'cell' — A cell
        - 'component' — A component
        - 'connector' — A connector between objects
        - 'ellipse' — An ellipse
        - 'embed' — An embed (video, bookmark, or iframe)
        - 'frame' — A frame
        - 'group' — A group of objects
        - 'image' — An image
        - 'line' — A line
        - 'pencil' — A freehand pencil drawing
        - 'polygon' — A polygon
        - 'rectangle' — A rectangle
        - 'stamp' — A stamp
        - 'thread' — A comment thread
        - 'text' — A text object
        - 'sticky_note' — A sticky note
      - `cell_name` string — The name of the cell
      - `cell_type` union — The type of cell
        - 'code' — A SQL query cell
        - 'python' — A Python script cell
        - 'csv' — A CSV file
        - 'api' — An API call cell
        - 'string' — A text control
        - 'number' — A number control
        - 'date' — A date picker control
        - 'single_select' — A single-select control
        - 'mcp' — An MCP tool call cell
        - 'multiple_select' — A multi-select control
        - 'slider' — A slider control
        - 'toggle' — A toggle control
        - 'table' — A table cell
        - 'table_filter' — A table filter cell
        - 'visual' — A visual cell
      - `catalog_key` string — The key of the connected catalog
      - `content` string — The contents of the object. For SQL and Python cells, this is the query or script. For text objects, this is the markdown-formatted text. Note - no compilation is performed on cell contents. To view compiled SQL for cells, use one of the querying endpoints with `cache_strategy = 'cached_only'`.
      - `frame_key` string — The key of the parent frame, if any
      - `group_key` string — The key of the parent group, if any
      - `connection_key` string — The key of the connected data source
      - `modified_at` string, date-time — An ISO 8601 date-time string.
      - `modified_by` string — The unique identifier for the user
      - `title` string — The title of the object

## Other responses

- `4XX` — Client error. Possible status codes include: 400 (invalid request), 401 (missing or invalid API key), 403 (insufficient permissions), 404 (resource not found), 429 (rate limit exceeded).
- `5XX` — Internal server error.

---

[API](https://skmtc.net/count/apis/count-public-api.md) · [All operations](https://skmtc.net/count/apis/count-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/count/count-public-api/versions/858ed44750ff/schema)