---
title: "List share links"
method: GET
path: "/v1/diagrams/{id}/links"
tags: ["Diagrams"]
---

# List share links

`GET /v1/diagrams/{id}/links`

## Request

- Base URL: `https://api.zindex.ai`
- URL: `https://api.zindex.ai/v1/diagrams/{id}/links`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

The diagram's share links, newest first.

## Path parameters

- `id` string, required

## Response `200`

{ id, links }

- object
  - `id` string, required
  - `links` ShareLink[], required
    - `linkId` string, required: lnk_ plus 12 characters; names the link for revoking it
    - `url` string, uri, required: https://zindex.ai/d/{token}: the page, following the latest version; add @{revision} for one version
    - `svg` string, uri, required: The latest version's image as SVG
    - `png` string, uri, required: The latest version's image as PNG
    - `createdAt` string, date-time, required
    - `createdBy` object, nullable: Who made the link; null for older links and for an account that has closed
      - `userId` string, required
      - `name` string, required

## Other responses

- `401`: Missing or invalid API key. Response includes a `code` field that distinguishes the failure mode so clients (dashboard, MCP server) can render actionable copy: `AUTH_REQUIRED` (no key or session was sent), `API_KEY_INVALID` (key not found), `API_KEY_REVOKED` (key was revoked, or its person is no longer in its workspace), `API_KEY_EXPIRED` (key passed its expires_at), and for the site's session cookie `SESSION_EXPIRED` (past its 24 hours), `SESSION_REVOKED` (the account's sessions were ended, for example by a password reset) and `SESSION_INVALID` (not a session this server signed).
- `403`: READ_ONLY: a read key or a viewer; a link is the power to share
- `404`: NOT_FOUND
- `429`: RATE_LIMITED: over the request rate limit (see Rate Limiting). Wait retryAfter seconds (also the Retry-After header), then try again.

---

[API](https://skmtc.dev/zindex/apis/zindex-api.md) · [All operations](https://skmtc.dev/zindex/apis/zindex-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zindex/apis/zindex-api/revisions/1d21bd5bbf8e?raw)