---
title: "Get paginated list of customers"
method: GET
path: "/api/customer"
tags: ["Customer"]
---

# Get paginated list of customers

`GET /api/customer`

Returns a paginated list of customers belonging to the authenticated merchant. Supports filtering by search term (matches email, first name, or last name), whether the customer has an active payment method, billing country, and whether they are purchasing as a business. Use the `page` and `limit` query parameters to control pagination.

## Query parameters

- `search` string
- `hasPaymentMethod` boolean
- `country` string
- `purchasingAsBusiness` boolean
- `page` number
- `limit` number

## Response `200`

Paginated list of customers matching the filters.

- PaginatedCustomersResponseDto
  - `data` CustomerListItemDto[], required — List of customers
    - `id` string, required — Unique identifier of the customer
    - `email` string, nullable, required — Email address of the customer
    - `firstName` string, nullable, required — First name of the customer
    - `lastName` string, nullable, required — Last name of the customer
    - `phone` string, nullable, required — Phone number of the customer
    - `billingCountry` string, nullable, required — Billing country code (ISO 3166-1 alpha-2)
    - `businessName` string, nullable, required — Business name if purchasing as a business
    - `purchasingAsBusiness` boolean, required — Whether the customer is purchasing as a business
    - `createdAt` string, date-time, required — Date when the customer was created
    - `updatedAt` string, date-time, required — Date when the customer was last updated
    - `paymentMethod` CustomerPaymentMethodSummaryDto, required
      - `type` string, required — Type of payment method
      - `cardBrand` string, nullable, required — Card brand (e.g., Visa, Mastercard)
      - `cardLast4` string, nullable, required — Last 4 digits of the card
    - `stats` CustomerStatsDto, required
      - `totalPayments` number, required — Total number of payments made by this customer
      - `totalSubscriptions` number, required — Total number of subscriptions for this customer
  - `meta` PaginationMetaDto, required
    - `total` number, required — Total number of customers matching the filters
    - `lastPage` number, required — Last page number available
    - `currentPage` number, required — Current page number
    - `perPage` number, required — Number of customers per page
    - `prev` number, nullable, required — Previous page number (null if on first page)
    - `next` number, nullable, required — Next page number (null if on last page)

## 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)
