canvases

Read a grid canvas's layout document and its current_version_id.

Always call this before editing: pass the returned version id as expected_current_version_id on publish/patch so concurrent edits are not overwritten. A grid canvas with no versions yet returns the default empty layout with a null version id.

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

Request

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

Path parameters

idstring uuid required

A UUID string identifying this canvas.

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

include_componentsboolean

Also return the renderable build (with signed artifact URL) of every component the layout's live placements reference, so a grid renders from this one call.

version_idstring

Read this historical layout version instead of the head (for version browsing).

Response

current_version_idstring nullable required

The live layout version this document reflects — pass as expected_current_version_id when publishing or patching. Null before the first layout publish.

Changes

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