---
title: "Retrieve all pay-links created by an API client"
method: GET
path: "/pay-links"
tags: ["pay-links"]
---

# Retrieve all pay-links created by an API client

`GET /pay-links`

Requires **pay_link:read** scope. Default limit is set to 10.

## Query parameters

- `limit` integer
- `offset` integer
- `widgetId` string, uuid
- `payeeId` string, uuid
- `isActive` boolean

## Response `200`

Successful PayLink Response

- object
  - `data` PayLink[]
    - `id` string, uuid, required — The id of the pay-link
    - `clientId` string, uuid, required — The id of the client
    - `widgetId` string, uuid, required — The id of the widget used to render the pay-link
    - `payeeId` string, uuid, required — The id of the payee
    - `reference` string, required — Reference to display on payer's statement
    - `amount` integer, required — Payment amount in minor units of the currency, eg. pennies for GBP.
    - `endToEndId` string, nullable, required — Unique identifier relevant to the transaction - Allowed characters (a-zA-Z0-9 :-).
    - `useOnce` boolean — Boolean to indicate if the pay-link can only be consumed once.
    - `usedAt` string, date-time, nullable — The date the pay-link was last used
    - `archivedAt` string, date-time, nullable, required — The date the pay-link was archived
    - `expiresAt` string, date-time, nullable — The date the pay-link will expire
    - `createdAt` string, date-time, required — The date that the pay-link was created.
    - `updatedAt` string, date-time, required — The date that the pay-link was modified.
  - `meta` Meta
    - `limit` integer
    - `offset` integer
    - `total` integer

## Other responses

- `401` — Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403` — Unsuccessful Response - Forbidden - Invalid scopes

---

[API](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service.md) · [All operations](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneyhubenterprise/moneyhub-identity-service/revisions/8841721f7aae/schema)