Topolo Docs Topolo Platform
Open workspace

List focused dashboards

Reads accessible dashboards in the credential's active ownership context without changing data.

Outcome

Reads accessible dashboards in the credential's active ownership context without changing data.

Before you start

  • Verify the intended environment, authenticated identity and explicitly authorized ownership context.
  • Discover the published dashboard:read permission and any required resource grant.

Discover the target

topolo whoami --json
topolo actions get app_topolo_one.dashboard_layouts.list --detail --json
  • scopeId: Exact owner id for the selected ownership scope. Inspect the granted context before supplying it.

Request

GET /api/dashboard-layouts

Inspect and test this action.

Input fields

FieldRequiredMeaningConstraints
scopeTypeRequiredExplicit Personal or organization ownership scope; private visibility does not switch credential context.{"type":"string","enum":["personal","organization","workspace"]}
scopeIdOptionalExact owner id for the selected ownership scope. Inspect the granted context before supplying it.{"type":"string","minLength":1}

Inspect nested fields.

Interpret the response

Confirm every returned dashboard matches the requested ownership scope. Private organization dashboards remain organization-scoped.

Inspect the declared output schema and captured variants.

Worked examples

Actual exported One Worker with local Miniflare D1/KV. Authentication, application discovery, checkout, billing and remote widget providers are controlled synthetic responses; outbound access is sealed. No live provider outcome is established.

Save the reviewed input below as payload.json; substitute discovered identifiers and bind credential/resource context separately. CLI:

topolo actions validate app_topolo_one.dashboard_layouts.list --data @payload.json --json
topolo actions plan app_topolo_one.dashboard_layouts.list --data @payload.json --json
topolo actions call app_topolo_one.dashboard_layouts.list --data @payload.json --detail --json

MCP planning and execution use the same reviewed input:

{
  "tool": "topolo_prepare_action",
  "arguments": {
    "actionId": "app_topolo_one.dashboard_layouts.list",
    "input": {
      "scopeType": "organization",
      "scopeId": "org_topolo_platform"
    }
  }
}
{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_one.dashboard_layouts.list",
    "input": {
      "scopeType": "organization",
      "scopeId": "org_topolo_platform"
    },
    "detail": true
  }
}

Successful response · HTTP 200

Input · payload.json:

{
  "scopeType": "organization",
  "scopeId": "org_topolo_platform"
}

Captured response:

{
  "data": {
    "dashboards": [
      {
        "id": "shared",
        "ownerUserId": "b1c4m4miIdDqq5UT",
        "organizationId": "org_topolo_platform",
        "scopeType": "organization",
        "scopeId": "org_topolo_platform",
        "name": "Executive overview",
        "description": "",
        "purpose": "custom",
        "timeContext": {
          "range": "30d",
          "comparison": "previous_period",
          "timezone": "UTC"
        },
        "visibility": "organization",
        "isDefault": true,
        "contributions": [],
        "analyses": [],
        "sharedUserIds": [],
        "canEdit": true,
        "createdAt": "before",
        "updatedAt": "before"
      },
      {
        "id": "dashboard_96cee461-3ae7-4acb-aad7-baf038ca5f8e",
        "ownerUserId": "b1c4m4miIdDqq5UT",
        "organizationId": "org_topolo_platform",
        "scopeType": "organization",
        "scopeId": "org_topolo_platform",
        "name": "Executive",
        "description": "A focused view of organization health, delivery capacity, publishing, and upcoming work.",
        "purpose": "executive",
        "timeContext": {
          "range": "30d",
          "comparison": "previous_period",
          "timezone": "Asia/Dubai"
        },
        "visibility": "private",
        "isDefault": true,
        "contributions": [
          {
            "id": "78e4b9d5-a580-4ce7-b51c-e57dc7eb1c62",
            "sourceId": "admin.organization-overview",
            "appId": "app_topolo_admin",
            "prominence": "standard",
            "resource": {
              "type": "organization",
              "id": "org_topolo_platform",
              "label": "Topolo Technology"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "organization",
              "resourceId": "org_topolo_platform",
              "heroMetricKey": "activeRate"
            }
          },
          {
            "id": "10f9f47f-86b4-427e-ae43-94eb0587dc8f",
            "sourceId": "agent.workspace-activity",
            "appId": "app_topolo_agent",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "ws_01m113pm6k14dpq0rad3vhrfx2",
              "label": "Topolo Core Agents"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "ws_01m113pm6k14dpq0rad3vhrfx2"
            }
          },
          {
            "id": "e6e36c8b-360f-4dd3-860d-1f8bc8f7309f",
            "sourceId": "blog.editorial-operations",
            "appId": "app_topolo_blog",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "ws_01kzjqynwhaph24ww3pdy7gjjp",
              "label": "Topolo.io Blog"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "ws_01kzjqynwhaph24ww3pdy7gjjp"
            }
          },
          {
            "id": "b9f75346-acd8-4734-901b-4078e1703c3b",
            "sourceId": "brand.workspace-summary",
            "appId": "app_topolo_brand",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "brand_workspace_e58577ee-f063-4192-b6f5-b71f60a09ae0",
              "label": "Default workspace"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "brand_workspace_e58577ee-f063-4192-b6f5-b71f60a09ae0"
            }
          },
          {
            "id": "08353aff-5ce5-4741-a478-f7992b9876ef",
            "sourceId": "bytes.workspace-storage",
            "appId": "app_topolo_bytes",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "ws_01kzy3ad974nb6vp7s1hyp5wmy",
              "label": "Topolo Technology"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "ws_01kzy3ad974nb6vp7s1hyp5wmy",
              "heroMetricKey": "storage_used"
            }
          },
          {
            "id": "fec099b9-5161-4cc9-9032-5b605f856c84",
            "sourceId": "calendar.booking-operations",
            "appId": "app_topolo_calendar",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "ws_01m0vs0pt6s49dzccqf1jj9h84",
              "label": "Default"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "ws_01m0vs0pt6s49dzccqf1jj9h84"
            }
          },
          {
            "id": "b5cfe925-4949-4ba6-8477-c8c0620c5450",
            "sourceId": "roadmapper.delivery-operations",
            "appId": "app_topolo_roadmapper",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "ws_01ky9st85wq6p7vcm77yjbnktn",
              "label": "ws_01ky9st85wq6p7vcm77yjbnktn"
            },
            "metricKeys": [
              "projects",
              "activeProjects",
              "projectsOnHold",
              "roadmaps",
              "activeRoadmaps",
              "plannedItems",
              "inProgressItems",
              "blockedItems",
              "completedItems",
              "completionRate"
            ],
            "actionIds": [
              "create-project"
            ],
            "configuration": {
              "visualization": "stats"
            }
          }
        ],
        "analyses": [],
        "sharedUserIds": [],
        "canEdit": true,
        "createdAt": "2026-09-03T06:27:31.643Z",
        "updatedAt": "2026-09-07T13:04:13.060Z"
      },
      {
        "id": "dashboard_ce6e4eba-9f38-471d-99c6-8ea35614e442",
        "ownerUserId": "b1c4m4miIdDqq5UT",
        "organizationId": "org_topolo_platform",
        "scopeType": "organization",
        "scopeId": "org_topolo_platform",
        "name": "My work",
        "description": "The exact agent, publishing, campaign, and calendar workspaces where Ashley can act now.",
        "purpose": "my-work",
        "timeContext": {
          "range": "7d",
          "comparison": "previous_period",
          "timezone": "Asia/Dubai"
        },
        "visibility": "private",
        "isDefault": false,
        "contributions": [
          {
            "id": "my-work-agent",
            "sourceId": "agent.workspace-activity",
            "appId": "app_topolo_agent",
            "prominence": "standard",
            "resource": {
              "type": "workspace",
              "id": "ws_01m113pm6k14dpq0rad3vhrfx2",
              "label": "Topolo Core Agents"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "ws_01m113pm6k14dpq0rad3vhrfx2"
            }
          },
          {
            "id": "my-work-blog",
            "sourceId": "blog.editorial-operations",
            "appId": "app_topolo_blog",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "ws_01kzjqynwhaph24ww3pdy7gjjp",
              "label": "Topolo.io Blog"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "ws_01kzjqynwhaph24ww3pdy7gjjp"
            }
          },
          {
            "id": "my-work-campaigns",
            "sourceId": "campaigns.activation-operations",
            "appId": "app_topolo_campaigns",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "campaigns_workspace_e5fcfbb8-4758-4fc7-b465-1d6bc26a12f3",
              "label": "Black Card // Dubai Pilot"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "campaigns_workspace_e5fcfbb8-4758-4fc7-b465-1d6bc26a12f3"
            }
          },
          {
            "id": "my-work-calendar",
            "sourceId": "calendar.booking-operations",
            "appId": "app_topolo_calendar",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "ws_01m0vs0pt6s49dzccqf1jj9h84",
              "label": "Default"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "ws_01m0vs0pt6s49dzccqf1jj9h84"
            }
          }
        ],
        "analyses": [],
        "sharedUserIds": [],
        "canEdit": true,
        "createdAt": "2026-09-07T08:23:55.544Z",
        "updatedAt": "2026-09-07T08:23:55.544Z"
      },
      {
        "id": "dashboard_8bbd6174-7a17-4f0d-9347-894b50bc9d74",
        "ownerUserId": "b1c4m4miIdDqq5UT",
        "organizationId": "org_topolo_platform",
        "scopeType": "organization",
        "scopeId": "org_topolo_platform",
        "name": "Content",
        "description": "Editorial, campaign, social, survey, and website activity in their exact production workspaces.",
        "purpose": "content",
        "timeContext": {
          "range": "30d",
          "comparison": "previous_period",
          "timezone": "Asia/Dubai"
        },
        "visibility": "private",
        "isDefault": false,
        "contributions": [
          {
            "id": "0dd44c39-50c6-4573-86f5-46acc123bb63",
            "sourceId": "blog.editorial-operations",
            "appId": "app_topolo_blog",
            "prominence": "standard",
            "resource": {
              "type": "workspace",
              "id": "ws_01kzjqynwhaph24ww3pdy7gjjp",
              "label": "Topolo.io Blog"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "ws_01kzjqynwhaph24ww3pdy7gjjp"
            }
          },
          {
            "id": "8f9dbda7-c09b-4c31-bbcf-c2afd02f47d0",
            "sourceId": "campaigns.activation-operations",
            "appId": "app_topolo_campaigns",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "campaigns_workspace_e5fcfbb8-4758-4fc7-b465-1d6bc26a12f3",
              "label": "Black Card // Dubai Pilot"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "campaigns_workspace_e5fcfbb8-4758-4fc7-b465-1d6bc26a12f3",
              "resourceLabel": "Black Card // Dubai Pilot"
            }
          },
          {
            "id": "53ad80d9-c44f-4a85-a4df-23bcf19536cd",
            "sourceId": "socialize.content-operations",
            "appId": "app_topolo_socialize",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "brand_1768052136771_35umeby96",
              "label": "Topolo Technology Brand"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "brand_1768052136771_35umeby96"
            }
          },
          {
            "id": "content-socialize-founder",
            "sourceId": "socialize.content-operations",
            "appId": "app_topolo_socialize",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "ws_01kz3q85g09m87vf6317r1gvz5",
              "label": "Ashley Lane - Topolo Founder"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "ws_01kz3q85g09m87vf6317r1gvz5"
            }
          },
          {
            "id": "7cd63b72-cecd-4038-9259-99e0bdbe94c6",
            "sourceId": "social-studio.workspace-overview",
            "appId": "app_topolo_social_studio",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "ws_ac6d22827ddd4a9fabb9a4cf0c957205",
              "label": "Topolo Technology"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "ws_ac6d22827ddd4a9fabb9a4cf0c957205"
            }
          },
          {
            "id": "5f15ab90-e2cb-4334-8420-217a87b6d2e6",
            "sourceId": "survey.workspace-activity",
            "appId": "app_topolo_survey",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "ws_01ky9st85ve0bj7w97nj70x135",
              "label": "Survey workspace"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "ws_01ky9st85ve0bj7w97nj70x135"
            }
          },
          {
            "id": "e6913d75-d85c-4f3e-b46c-d755481578bb",
            "sourceId": "web.website-operations",
            "appId": "app_topolo_web",
            "prominence": "compact",
            "resource": {
              "type": "workspace",
              "id": "web_workspace_org_topolo_platform",
              "label": "Default workspace"
            },
            "metricKeys": [],
            "actionIds": [],
            "configuration": {
              "visualization": "stats",
              "resourceType": "workspace",
              "resourceId": "web_workspace_org_topolo_platform"
            }
          }
        ],
        "analyses": [],
        "sharedUserIds": [],
        "canEdit": true,
        "createdAt": "2026-09-03T22:54:07.070Z",
        "updatedAt": "2026-09-07T08:23:41.373Z"
      }
    ]
  }
}

Confirm every returned dashboard matches the requested ownership scope. Private organization dashboards remain organization-scoped.

Refused request · HTTP 403 · personal_context_required

Input · payload.json:

{
  "scopeType": "personal"
}

Captured response:

{
  "error": "personal_context_required"
}

Use the intended Personal context; private organization visibility is a different ownership scope.

Refused request · HTTP 401 · auth_error

Input · payload.json:

{
  "scopeType": "organization",
  "scopeId": "org_topolo_platform"
}

Captured response:

{
  "error": "Token validation failed"
}

Authenticate using the required credential type for this action; service-only actions require the registered Auth service identity.

Verify the result

  • Confirm every returned dashboard matches the requested ownership scope. Private organization dashboards remain organization-scoped.

Errors and recovery

  • personal_context_required (HTTP 403): Use the intended Personal context; private organization visibility is a different ownership scope.
  • auth_error (HTTP 401): Authenticate using the required credential type for this action; service-only actions require the registered Auth service identity.

These are observed local refusals; inspect the raw error body because one SDK code can represent several handler messages. Preserve the request id when available.

Recovery boundary

This read changes no saved dashboard.

Evidence

Actual exported One Worker with local Miniflare D1/KV. Authentication, application discovery, checkout, billing and remote widget providers are controlled synthetic responses; outbound access is sealed. No live provider outcome is established.