---
title: "Search & list holders"
method: GET
path: "/merchant/holders"
tags: ["Holders"]
---

# Search & list holders

`GET /merchant/holders`

Search & list holders.

## Query parameters

- `filter[reference]` string
- `filter[id]` string
- `filter[status]` string
- `page[after]` string — Cursor for paging results.
- `page[before]` string — Cursor for paging results.
- `page[size]` integer

## Response `200`

Success.

- object
  - `links` object, required
    - `self` string, required
    - `prev` string
    - `next` string
    - `first` string
    - `last` string
  - `results` object[], required
    - `id` string, uuid, required — Unique identifier of the Holder in Payrails.
    - `reference` string, required — Merchant-provided reference for the transaction counterparty, i.e. the paying consumer.
    - `createdAt` string, date-time — Date and time when the Holder was created.
    - `status` string[] — Status of the Holder in Payrails.
    - `type` string — Value of merchant-defined enumeration of Holder Types.

## Other responses

- `401` — Unauthorized.
- `403` — Insufficient Scope.

---

[API](https://skmtc.net/payrails/apis/payrails-api-reference.md) · [All operations](https://skmtc.net/payrails/apis/payrails-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payrails/payrails-api-reference/revisions/9dd2f0158582/schema)