---
title: "List all Shares"
method: GET
path: "/api/v1/shares"
tags: ["Shares"]
---

# List all Shares

`GET /api/v1/shares`

## Query parameters

- `network_id` string, uuid, nullable
- `topology_id` string, uuid, nullable
- `limit` integer, nullable
- `offset` integer, nullable

## Response `200`

List of Shares

- object — Response type for paginated list endpoints (pagination is always present in meta)
  - `data` Share[], required — The page of results. Empty when nothing matched the query.
    - `allowed_domains` string[], nullable, required — Domains permitted to embed this share. Empty means no restriction.
    - `created_by` string, uuid, required — User who created the share.
    - `enabled_views` TopologyView[], nullable, required — Which topology views are enabled for this share. None = all views (subject to data availability). Some(list) = only these views in order. First element is the default view shown on load.
    - `expires_at` string, date-time, nullable, required — When this record stops being valid.
    - `is_enabled` boolean, required — Whether the link still resolves. Disabled shares return 404.
    - `name` string, required — Human-facing name for this share.
    - `network_id` string, uuid, required — The network this entity belongs to.
    - `options` ShareOptions, required — Share display options
      - `show_export_button` boolean, required — Viewer sees the export button.
      - `show_inspect_panel` boolean, required — Viewer can open the inspector for a selected element.
      - `show_minimap` boolean, required — Viewer sees the minimap.
      - `show_zoom_controls` boolean, required — Viewer sees the zoom controls.
    - `password` string, password, nullable — Plaintext password on ingest; redacted sentinel (`"********"`) or `None` on egress. Never stored — `password_hash` is the DB column. Wrapped in `SecretString` so `Debug`/logging shows `[REDACTED]` during the window between request deserialization and hashing.
    - `topology_id` string, uuid, required — The topology this share exposes.
    - `created_at` string, date-time, required — When this record was first created.
    - `id` string, uuid, required — Server-assigned unique identifier.
    - `updated_at` string, date-time, required — When this record was last modified.
  - `error` string, nullable — Human-readable failure message. Omitted on success.
  - `meta` PaginatedApiMeta, required — API metadata for paginated list responses (pagination is always present)
    - `api_version` integer, required — API version (integer, increments on breaking changes)
    - `pagination` PaginationMeta, required — Pagination metadata returned with paginated responses.
      - `group_counts` GroupCount[], nullable — Size of every group, in the same order the rows are grouped, when the request specified a `group_by`. Lets a paginated client show a group's true size instead of the slice of it that happens to be on this page. Absent when the list isn't grouped.
        - `count` integer, required — How many rows fall in this group in total, not just on this page.
        - `value` string, nullable — The group's value, rendered as text. `null` for rows whose group key is NULL (the "ungrouped" bucket).
      - `has_more` boolean, required — Whether there are more items after this page
      - `limit` integer, required — Maximum items per page (as requested)
      - `offset` integer, required — Number of items skipped
      - `total_count` integer, required — Total number of items matching the filter (ignoring pagination)
    - `server_version` string, required — Server version (semver)
  - `success` boolean, required — `true` when the request succeeded. `false` responses carry `error` instead of `data`.

---

[API](https://skmtc.net/scanopy/apis/scanopy-api.md) · [All operations](https://skmtc.net/scanopy/apis/scanopy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scanopy/scanopy-api/revisions/2df1fc47dfa7/schema)