canvases

Get or provision the caller's home canvas.

Idempotent: returns the user's existing home canvas, or creates a grid canvas in their personal channel and points their home preference at it. The home surface calls this on open.

post/api/projects/{project_id}/canvases/home/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/canvases/home/
  • 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/.

Response

The caller's existing home canvas.

idstring uuid required
namestring required
kind'freeform' | 'grid' | 'component' required
  • freeform - freeform
  • grid - grid
  • component - component
descriptionstring required

Short prose describing the canvas. For components, the store-search text.

channelstring uuid required
template_idstring required
generation_task_idstring uuid nullable required
pinnedboolean required

Whether the canvas is pinned to its channel.

pinned_atstring date-time nullable required
current_version_idstring uuid nullable required

Id of the live source version — pass as expected_current_version_id on publish. Null before the first publish.

published_build_idstring uuid nullable required

Id of the canvas's live (last successful, still-eligible) build. Null until a build completes.

created_atstring date-time required
updated_atstring date-time required
urlstring required

Canonical link to the canvas in the PostHog app. The only valid way to link to a canvas — share this when pointing a user at it; never construct a canvas URL.

Changes

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