---
title: "List customers"
method: GET
path: "/v1/customers"
tags: ["Customers"]
---

# List customers

`GET /v1/customers`

Retrieve a paginated list of customers with optional search and filters.

## Query parameters

- `search` string
- `isActive` 'true' | 'false'
- `page` integer
- `limit` integer

## Response `200`

Customers listed.

- object
  - `customers` Customer[]
    - `customerId` string — Merchant-facing customer slug (e.g., `cus_ab12cd34ef`). Use this as the `{customerId}` path parameter in subsequent calls.
    - `name` string
    - `email` string
    - `document` string
    - `phone` string
    - `externalId` string
    - `isActive` boolean
    - `createdAt` string, date-time
  - `pagination` Pagination
    - `page` integer
    - `limit` integer
    - `total` integer
    - `totalPages` integer

## Other responses

- `401` — Missing or invalid authentication token.

## Changes

- **2026-05-03** `a382df24e843` — 1 warning, 1 info
  - removed the optional property `customers/items/id` from the response with the `200` status
  - added the optional property `customers/items/customerId` to the response with the `200` status
- **2026-04-14** `c75657100757` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/yuvexpay/apis/yuvexpay-api/changes/v1/customers/get.md)

---

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