---
title: "List your shared dashboard links"
method: GET
path: "/shared-dashboards"
tags: ["Shared Dashboards"]
---

# List your shared dashboard links

`GET /shared-dashboards`

Every share link the API key can see, one per shop that has one — `uuid`, the viewer `share_url`, `status`, any locked reporting window, and the `report_config` describing which cards the viewer sees.

The password is never returned; it is stored only as a hash. A shop with no link is simply absent from the list rather than returned as null. Works with a multi-shop key.

Read-only — no `read_write` scope needed.

## Response `200`

Successful Response

- SharedDashboardListResponse — Every share link the API key can see.
  - `data` MySharedDashboard[], required — One entry per shop that has a share link. May be empty.
    - `uuid` string, required
    - `share_url` string, required
    - `status` string, required
    - `created_at` string, required
    - `locked_start_date` string, date, nullable
    - `locked_end_date` string, date, nullable
    - `report_config` ShareReportConfig — Which metric cards and modules a share link shows an external viewer. An omitted/empty config is meaningful: it marks a legacy link, which renders the original fixed six-card layout. That is why ``metrics`` and ``modules`` default to None rather than to empty collections — "no opinion" and "the owner turned everything off" must stay distinguishable.
      - `v` integer — Config schema version
      - `metrics` string[], nullable — Metric keys to show, in display order
      - `modules` object, nullable — Per-module visibility, keyed by SHARE_MODULE_KEYS
    - `shop_id` integer, required — Shop this share link reports on.

---

[API](https://skmtc.dev/reacherapp/apis/reacher-data-api.md) · [All operations](https://skmtc.dev/reacherapp/apis/reacher-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/reacherapp/reacher-data-api/revisions/5eefff009b5b/schema)