Appearance
Workspaces
Workspaces are the top-level containers for plans and users in Visuary. Each workspace belongs to a company or team and has its own subscription level.
List workspaces
GET /public/v1/workspacesReturns all workspaces your token can access. For personal tokens this is all workspaces your Visuary account belongs to. For OAuth tokens this is all workspaces the authorizing user belongs to.
bash
curl https://api.visuary.com/public/v1/workspaces \
-H "Authorization: Bearer YOUR_TOKEN"Response 200 OK
json
[
{
"id": 42,
"name": "Acme Corp",
"logo": "https://assets.visuary.com/workspace/logo/abc.png"
},
{
"id": 57,
"name": "Interior Studio"
}
]logo is omitted when no logo has been set.
List plans in a workspace
GET /public/v1/workspaces/{workspace_id}/plansReturns all non-archived plans in the workspace. The token must have read access to the workspace.
bash
curl https://api.visuary.com/public/v1/workspaces/42/plans \
-H "Authorization: Bearer YOUR_TOKEN"Response 200 OK
json
[
{
"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"
}
]thumbnail is omitted when no thumbnail has been generated yet.
Data model
Workspace
| Field | Type | Description |
|---|---|---|
id | number | Unique workspace ID |
name | string | Workspace display name |
logo | string | URL of the workspace logo image (optional) |
See the Plan model for the full plan object shape returned by plan endpoints.