---
title: "Get Work Channel Canvas"
method: GET
path: "/work/channels/{channel_id}/canvas"
tags: ["Work"]
---

# Get Work Channel Canvas

`GET /work/channels/{channel_id}/canvas`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/work/channels/{channel_id}/canvas`
- Auth: HTTP bearer

One channel's Canvas, to a caller entitled to that channel.

``403`` when the caller may not read the channel — the same rule that
decides its messages, so a room cannot be readable on one half and refused
on the other. A channel with no Canvas answers an empty one rather than 404.

## Path parameters

- `channel_id` string, required: Channel id or slug

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseWorkCanvas
  - `data` WorkCanvas, required: One channel's Canvas document.
    - `channelId` string, nullable: Channel the canvas belongs to
    - `content` string, nullable: Canvas content
    - `revisionId` string, nullable: Current revision id
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)