Skip to content

Plans

A plan is a single floorplan document inside a workspace. Plans can have multiple floors, variants, and items.


List plans shared with you

GET /public/v1/plans/shared

Returns plans explicitly shared with the authenticated user across all workspaces — useful when a user has been given access to a specific plan without being a full workspace member.

bash
curl https://api.visuary.com/public/v1/plans/shared \
  -H "Authorization: Bearer YOUR_TOKEN"

Response 200 OK — same shape as workspace plans.

json
[
	{
		"id": "xYzAbCdE",
		"name": "Show Apartment",
		"workspace_id": 57,
		"thumbnail": "https://assets.visuary.com/plan/thumb/show.png",
		"created_at": "2024-01-10T08:00:00Z",
		"updated_at": "2024-05-02T11:15:00Z"
	}
]

Data model

See the Data Models page for the full Plan and Workspace object definitions.