---
title: "list share links"
method: GET
path: "/v1/share-links"
tags: ["Share Links"]
---

# list share links

`GET /v1/share-links`

Returns a list of all share links for the organization

## Query parameters

- `page` integer
- `perPage` integer
- `search` string
- `personaId` string, uuid

## Response `200`

Successfully retrieved share links

- object
  - `data` PersonaShareLink[]
    - `id` string, uuid — Unique identifier for the share link.
    - `token` string — Opaque token appended to the public URL.
    - `type` 'LINK' | 'PLAYER_EMBED' | 'ORB_EMBED' — Kind of share link — a direct URL, a player embed, or an orb embed.
    - `expiresAt` string, date-time, nullable — Timestamp after which the link no longer works, or `null` if the link does not expire.
    - `usageLimit` integer, nullable — Maximum number of times the link can be used, or `null` for unlimited.
    - `usageCount` integer — Number of times the link has been used.
    - `allowedOrigins` string[] — Origins permitted to load the link when embedded. Ignored when `allowAllOrigins` is true.
    - `allowAllOrigins` boolean — Whether the link can be embedded on any origin.
    - `removeWatermark` boolean — Whether the persona renders without the Anam watermark. Requires a plan that permits watermark removal.
    - `enabled` boolean — Whether the link currently accepts connections.
    - `isPrimary` boolean — Whether this is the persona's primary share link (at most one per persona).
    - `createdAt` string, date-time — Timestamp when the share link was created.
    - `personaId` string, uuid — ID of the persona this link points to.
    - `personaName` string — Name of the persona at the time the link was issued.
    - `organizationId` string — ID of the organization that owns the link. IDs may be either UUIDs or nanoid-style strings depending on when the organization was created.
  - `meta` Pagination — Pagination metadata returned alongside the `data` array of every list endpoint.
    - `total` integer — Total number of items across all pages.
    - `lastPage` integer — Number of the last page.
    - `currentPage` integer — Number of the current page.
    - `perPage` integer — Number of items per page.
    - `prev` integer, nullable — Number of the previous page, or null if on the first page.
    - `next` integer, nullable — Number of the next page, or null if on the last page.

## Other responses

- `400` — Bad request - Invalid query parameters
- `401` — Unauthorized - Invalid or missing API key
- `403` — Forbidden - API key lacks the required permission
- `500` — Server error

---

[API](https://skmtc.net/anam/apis/anam-ai-api.md) · [All operations](https://skmtc.net/anam/apis/anam-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/anam/anam-ai-api/versions/67afd1c5db59/schema)