> ## Documentation Index
> Fetch the complete documentation index at: https://anam.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# list share links

> Returns a list of all share links for the organization



## OpenAPI

````yaml https://api.anam.ai/swagger.json get /v1/share-links
openapi: 3.1.0
info:
  title: Anam AI API
  version: '1.0'
servers:
  - url: https://api.anam.ai
    description: Anam API
security:
  - BearerAuth: []
tags:
  - name: Sessions
  - name: Personas
  - name: Avatars
  - name: Voices
  - name: LLMs
  - name: Knowledge
  - name: Tools
  - name: Share Links
paths:
  /v1/share-links:
    get:
      tags:
        - Share Links
      summary: list share links
      description: Returns a list of all share links for the organization
      operationId: listShareLinks
      parameters:
        - in: query
          name: page
          schema:
            type: integer
            minimum: 1
            default: 1
          description: Page number for pagination
        - in: query
          name: perPage
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Number of items per page (max 100)
        - in: query
          name: search
          schema:
            type: string
          description: Search term to filter share links
        - in: query
          name: personaId
          schema:
            type: string
            format: uuid
          description: Filter share links by persona ID
      responses:
        '200':
          description: Successfully retrieved share links
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PersonaShareLink'
                  meta:
                    $ref: '#/components/schemas/Pagination'
              examples:
                default:
                  $ref: '#/components/examples/ShareLinkListResponse'
        '400':
          description: Bad request - Invalid query parameters
        '401':
          description: Unauthorized - Invalid or missing API key
        '500':
          description: Server error
components:
  schemas:
    PersonaShareLink:
      type: object
      description: >-
        A share link as returned by list and get endpoints — includes persona
        details for the link's target.
      allOf:
        - $ref: '#/components/schemas/ShareLink'
        - type: object
          properties:
            personaId:
              type: string
              format: uuid
              description: ID of the persona this link points to.
            personaName:
              type: string
              description: Name of the persona at the time the link was issued.
            organizationId:
              type: string
              description: >-
                ID of the organization that owns the link. IDs may be either
                UUIDs or nanoid-style strings depending on when the organization
                was created.
    Pagination:
      type: object
      description: >-
        Pagination metadata returned alongside the `data` array of every list
        endpoint.
      properties:
        total:
          type: integer
          description: Total number of items across all pages.
        lastPage:
          type: integer
          description: Number of the last page.
        currentPage:
          type: integer
          description: Number of the current page.
        perPage:
          type: integer
          description: Number of items per page.
        prev:
          type:
            - integer
            - 'null'
          description: Number of the previous page, or null if on the first page.
        next:
          type:
            - integer
            - 'null'
          description: Number of the next page, or null if on the last page.
    ShareLink:
      type: object
      description: >-
        A shareable link to a persona. Can be used as a direct URL or embedded
        via the widget.
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the share link.
        token:
          type: string
          description: Opaque token appended to the public URL.
        type:
          type: string
          enum:
            - LINK
            - PLAYER_EMBED
            - ORB_EMBED
          description: Kind of share link — a direct URL, a player embed, or an orb embed.
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Timestamp after which the link no longer works, or `null` if the
            link does not expire.
        usageLimit:
          type:
            - integer
            - 'null'
          description: >-
            Maximum number of times the link can be used, or `null` for
            unlimited.
        usageCount:
          type: integer
          description: Number of times the link has been used.
        allowedOrigins:
          type: array
          items:
            type: string
          description: >-
            Origins permitted to load the link when embedded. Ignored when
            `allowAllOrigins` is true.
        allowAllOrigins:
          type: boolean
          description: Whether the link can be embedded on any origin.
        removeWatermark:
          type: boolean
          description: >-
            Whether the persona renders without the Anam watermark. Requires a
            plan that permits watermark removal.
        enabled:
          type: boolean
          description: Whether the link currently accepts connections.
        isPrimary:
          type: boolean
          description: >-
            Whether this is the persona's primary share link (at most one per
            persona).
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the share link was created.
  examples:
    ShareLinkListResponse:
      summary: A paginated list of share links
      value:
        data:
          - id: 00000000-0000-0000-0000-000000000000
            token: sh_2kL9pQxYzR4vN8mBwHfJc
            type: LINK
            expiresAt: '2026-04-27T10:00:00.000Z'
            usageLimit: 10
            usageCount: 3
            allowedOrigins: []
            allowAllOrigins: false
            removeWatermark: false
            enabled: true
            isPrimary: false
            createdAt: '2026-04-20T10:00:00.000Z'
            personaId: 00000000-0000-0000-0000-000000000000
            personaName: Cara
            organizationId: 00000000-0000-0000-0000-000000000000
        meta:
          total: 1
          lastPage: 1
          currentPage: 1
          perPage: 20
          prev: null
          next: null
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````