---
title: "Get the list of payment links"
method: GET
path: "/api/link"
tags: ["Links"]
---

# Get the list of payment links

`GET /api/link`

Retrieves a paginated list of payment links for the authenticated user

## Query parameters

- `page` number
- `limit` number
- `isArchived` boolean

## Response `200`

- object
  - `data` ApiLinkDto[]
    - `id` string, required — The unique identifier of the link
    - `name` string, required — The name of the link
    - `amount` number, required — The total amount of the link in cents
    - `currency` 'EUR' | 'GBP' | 'USD', required — The currency of the link
    - `status` 'enabled' | 'disabled', required — The status of the link
    - `isArchived` boolean, required — Whether the payment link is archived
    - `products` object[], required — The list of products included in this link
      - `name` string
      - `price` number
      - `quantity` number
    - `paymentIds` string[], required — The list of payment IDs associated with this link
    - `sessionCustomization` SessionCustomizationDto, required
      - `bgColor` string, nullable — Background color for the payment session
      - `fontColor` string, nullable — Font color for the payment session
      - `logoUrl` string, nullable — Logo URL for the payment session
      - `merchantName` string, nullable — Merchant name for the payment session
    - `paymentLinkUrl` string, required — The URL to access the payment link
    - `statementDescriptor` string, nullable — Optional statement descriptor (max 11 characters) shown on the customer's bank statement
    - `createdAt` string, date-time, required — The creation date of the link
    - `updatedAt` string, date-time, required — The last update date of the link
  - `meta` object
    - `total` number
    - `lastPage` number
    - `currentPage` number
    - `perPage` number
    - `prev` number
    - `next` number

## Other responses

- `401` — Unauthorized - Invalid API key

---

[API](https://skmtc.dev/inflowpay/apis/inflow-api.md) · [All operations](https://skmtc.dev/inflowpay/apis/inflow-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/inflowpay/inflow-api/revisions/3012dd3dd14a/schema)