Get Canvas State By Branch

Get canvas state for a node at a specific branch with flat structure.

Returns a flat dictionary where keys are node IDs and values are complete state objects. The parent node’s child_nodes field contains only child node IDs (not nested objects). Each child node gets its own entry in the dictionary.

Query params: resolve_children: “latest” (default) shows children at their current main HEAD. “snapshot” shows children as they were when last pushed. include_related: “slim” (default) keeps parent_nodes as stubs and leaves ingress/egress counterparties unresolved. “full” promotes each parent and each ingress/egress counterparty to its own top-level entry (mirroring children) and rewrites the root’s parent_nodes field to a list of UUIDs.

GET /orgs/{org_id}/nodes/{node_id}/tree/{branch}/canvas

Get Canvas State By Branch

cURL

curl --request GET \
  --url https://api.yertle.com/orgs/{org_id}/nodes/{node_id}/tree/{branch}/canvas

200

{}

Headers

authorization · string | null

Path Parameters

org_id · string<uuid> · required

node_id · string · required

branch · string · required

Query Parameters

resolve_children · string · default: latest

Pattern: ^(latest|snapshot)$

include_related · string · default: slim

Pattern: ^(slim|full)$

Response

200

application/json

Successful Response

Flat canvas state — dictionary keyed by node ID.

Each value is a push-compatible state object for that node. The schema is inherently dynamic because keys are UUIDs, so this response type is a passthrough JSON object.