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

# List Links

> List your pay links, newest first, with cursor pagination. Authenticate with a merchant API key or your dashboard session.

```bash theme={null}
curl "https://api.xenarch.dev/v1/links?limit=10" \
  -H "Authorization: Bearer xm_live_..."
```

```json 200 theme={null}
{
  "links": [
    {
      "link_id": "JJjIwDyV4N1CG9g8AHMxfdJ9",
      "created_at": "2026-11-17T12:00:00Z",
      "expires_at": null,
      "kind": "checkout",
      "status": "active",
      "paid_and_single_use": false,
      "paid_count": 0,
      "views": 0,
      "revenue_usd": "0",
      "amount_usd": "25.00",
      "cadence": "one_time"
    }
  ],
  "has_more": false,
  "next_cursor": null
}
```

## Authentication

`Authorization: Bearer xm_live_...` (merchant API key) or the `xen_session` cookie.

## Query parameters

| Parameter | Type | Description |
| - | - | - |
| `limit` | integer | Page size, 1 to 100. Default 25. |
| `starting_after` | string | The `next_cursor` from the previous page |

## Fields

| Field | Description |
| - | - |
| `status` | `active`, `expired` or `revoked` |
| `amount_usd` | The link's amount as signed, or `"open"` for a pay-what-you-want link |
| `cadence` | The link's `type` param, such as `one_time` or `per_month`. `null` when the link does not set it. |
| `paid_and_single_use` | `true` once a single-use link has been paid |
| `paid_count` | `1` for a paid single-use link, otherwise `0` |

The list endpoint does not compute `views` or `revenue_usd`, and `paid_count` does not count payments on reusable links. For those numbers use [Get Link](https://docs.xenarch.com/api-reference/links/get.md) with your dashboard session, or `GET /v1/payments/received`.


## OpenAPI

````yaml GET /v1/links
openapi: 3.1.0
info:
  title: Xenarch API
  version: 0.1.0
servers:
  - url: https://api.xenarch.dev
security: []
paths:
  /v1/links:
    get:
      tags:
        - pay-links
      summary: List Links
      description: List the authenticated seller's pay links.
      operationId: list_links_v1_links_get
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 25
            title: Limit
        - name: starting_after
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Starting After
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayLinkListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PayLinkListResponse:
      properties:
        links:
          items:
            $ref: '#/components/schemas/PayLinkListItem'
          type: array
          title: Links
        has_more:
          type: boolean
          title: Has More
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
      type: object
      required:
        - links
        - has_more
      title: PayLinkListResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PayLinkListItem:
      properties:
        link_id:
          type: string
          title: Link Id
        created_at:
          type: string
          format: date-time
          title: Created At
        expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Expires At
        kind:
          type: string
          title: Kind
        status:
          type: string
          enum:
            - active
            - expired
            - revoked
          title: Status
        paid_and_single_use:
          type: boolean
          title: Paid And Single Use
          default: false
        paid_count:
          type: integer
          title: Paid Count
          default: 0
        views:
          type: integer
          title: Views
          default: 0
        revenue_usd:
          type: string
          title: Revenue Usd
          default: '0'
        amount_usd:
          anyOf:
            - type: string
            - type: 'null'
          title: Amount Usd
        cadence:
          anyOf:
            - type: string
            - type: 'null'
          title: Cadence
      type: object
      required:
        - link_id
        - created_at
        - expires_at
        - kind
        - status
      title: PayLinkListItem
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.