canvases

Canvases: agent-built sandboxed browser apps, filed into channels.

Source is versioned per publish and built server-side; the canvas app renders the published build's artifact from the isolated artifact origin.

get/api/projects/{project_id}/canvases/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/canvases/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

channelstring uuid

Only return canvases in this channel.

kind'component' | 'freeform' | 'grid'

Only return canvases of this kind. kind=component lists the component store.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

ordering'-created_at' | '-updated_at'

Sort order. -created_at (default) puts the newest canvases first. -updated_at puts the most recently changed canvases first.

searchstring

Only return canvases whose name or description contains this text (case-insensitive).

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

No recorded changes to this operation across all 1 revision of this API.