canvases

Read the canvas's runtime key-value state (the ph.state store).

Returns shared entries plus the authenticated user's own user-scoped entries — never another user's.

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

Request

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

cursorstring

Cursor from next_cursor. Resumes after the last entry of the previous page, so an entry that exists for the whole read comes back exactly once. A key written between pages can be missing. Keep filters unchanged between pages. Takes precedence over offset.

keystring

Only read this exact key.

key_prefixstring

Only read entries whose key starts with this prefix.

keys_onlyboolean

True returns a key inventory without stored values.

limitinteger

Maximum entries per page. Omit for the full state. Prefer an inventory and state/value for large values.

offsetinteger

Entry offset from next_offset. Keep filters unchanged between pages. Prefer cursor: an offset can skip or repeat entries when state changes between pages.

scope'user' | 'shared'

Only read this scope.

  • user - user
  • shared - shared

Response

next_offsetinteger nullable required

Next entry offset, or null when complete. Null when the request used a cursor.

next_cursorstring nullable required

Cursor for the next page, or null when complete. Pass it as cursor.

completeboolean required

True when no further entries remain for this selection.

Changes

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