canvases

Read the canvas's source project and its current_version_id.

Always call this before editing: edit the returned files, then publish the complete project passing the returned version id as expected_current_version_id so concurrent edits are not overwritten. ?version_id= reads a historical version instead of the head.

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

Request

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

version_idstring

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

Response

current_version_idstring nullable required

The live source version this project reflects — pass as expected_current_version_id when publishing an edit. Null before the first publish.

Changes

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