Data Models

This page describes the JSON object shapes returned by the Visuary Public API.

---

Workspace

Returned by List workspaces.

{
	"id": 42,
	"name": "Acme Corp",
	"logo": "https://assets.visuary.com/workspace/logo/abc.png"
}

Field	Type	Description
id	number	Unique numeric workspace ID
name	string	Workspace display name
logo	string	URL of the workspace logo image (optional)

---

Plan

Returned by List plans in a workspace and List shared plans.

{
	"id": "aBcDeFgH",
	"name": "Apartment 4B",
	"workspace_id": 42,
	"thumbnail": "https://assets.visuary.com/plan/thumb/xyz.png",
	"created_at": "2024-03-01T10:00:00Z",
	"updated_at": "2024-04-15T14:30:00Z"
}

Field	Type	Description
id	string	Unique plan identifier (opaque string, use as-is in export endpoints)
name	string	Plan display name
workspace_id	number	ID of the workspace this plan belongs to
thumbnail	string	URL of the plan thumbnail image (optional — absent until first save with thumbnail)
created_at	string	ISO 8601 timestamp of plan creation
updated_at	string	ISO 8601 timestamp of last modification

The plan id is a short opaque string. Always treat it as an opaque identifier — pass it directly to export endpoints without parsing or modifying it.