---
title: "List customers"
method: GET
path: "/billing/customers"
---

# List customers

`GET /billing/customers`

## Request

- Base URL: `https://api-sandbox.ezypay.com/v2`
- URL: `https://api-sandbox.ezypay.com/v2/billing/customers`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://identity-sandbox.ezypay.com/token`

Retrieve a list of customers that belong to the merchant.

## Query parameters

- `name` string
- `firstName` string
- `lastName` string
- `companyName` string
- `referenceCode` string
- `customerNumber` string
- `createdDate` string
- `sortExpression` string
- `limit` integer
- `cursor` integer

## Headers

- `merchant` string, required

## Response `200`

200

- object
  - `data` object[]
    - `id` string
    - `number` string
    - `referenceCode` string
    - `firstName` string
    - `lastName` string
    - `email` string
    - `companyName` string
    - `mobilePhone` string
    - `homePhone` unknown
    - `gender` string
    - `dateOfBirth` unknown
    - `createdOn` string
    - `address` object
      - `address1` string
      - `address2` unknown
      - `postalCode` unknown
      - `state` unknown
      - `countryCode` string
      - `city` unknown
    - `metadata` unknown

## Changes

- **2026-11-03** `924be4030f56`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ezypay/apis/vault/changes/billing/customers/get.md)

---

[API](https://skmtc.dev/ezypay/apis/vault.md) - [All operations](https://skmtc.dev/ezypay/apis/vault/llms.txt) - [OpenAPI document](https://skmtc.dev/ezypay/apis/vault/revisions/924be4030f56?raw)