---
title: "Retrieve Links"
method: GET
path: "/api/v1/links"
tags: ["Links"]
---

# Retrieve Links

`GET /api/v1/links`

Get a paginated list of payment links with optional status filtering. Returns links ordered by creation date (newest first).

## Query parameters

- `take` integer
- `skip` integer
- `statuses` string[]

## Response `200`

A list of links

- object
  - `data` object[] — Array of payment links
    - `customParameter` string, nullable — Custom parameter for tracking
    - `referenceId` string — Your unique reference ID
    - `id` string — Wayl's unique identifier
    - `total` string — Total amount as string
    - `currency` string — Payment currency
    - `type` string — Link type
    - `paymentMethod` string, nullable — Payment method used
    - `status` string — Current payment status
    - `completedAt` string, nullable — Payment completion timestamp
    - `createdAt` string — Creation timestamp
    - `updatedAt` string — Last update timestamp
    - `url` string — Payment URL
    - `webhookUrl` string — Webhook URL
    - `redirectionUrl` string — Redirection URL
    - `linkExpiresIn` string — Duration until the payment link expires (e.g. "30m", "1h", "24h")
  - `message` string — Response message

---

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