---
title: "get share link"
method: GET
path: "/v1/share-links/{id}"
tags: ["Share Links"]
---

# get share link

`GET /v1/share-links/{id}`

Returns a share link by ID

## Path parameters

- `id` string, uuid, required

## Response `200`

Successfully retrieved share link

- PersonaShareLink — A shareable link to a persona. Can be used as a direct URL or embedded via the widget.
  - `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.

## Other responses

- `400` — Bad request - Invalid share link ID
- `401` — Unauthorized - Invalid or missing API key
- `403` — Forbidden - API key lacks the required permission
- `404` — Not Found - Share link not found
- `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)