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

# List Customers

`GET /v5/customers`

Retrieve a list of all customers for the merchant with optional filtering and cursor-based pagination.

## Query parameters

- `id` string
- `include_partial_id_matches` boolean
- `first_name` string
- `last_name` string
- `billing_id` string
- `shipping_id` string
- `email` string, email
- `account_number` string
- `company` string
- `date_from` string, date
- `date_to` string, date
- `cc_expiring` boolean
- `acu_halted` boolean
- `cursor` integer
- `per_page` integer

## Response `200`

Success

- object
  - `customers` CustomerResponse[]
    - `object` 'customer', required — Resource type identifier
    - `id` string, required — Customer vault ID
    - `created` string, date-time, nullable — Customer creation date in UTC ISO 8601 format
    - `billing` object[] — Array of billing addresses
      - `object` 'billing', required — Resource type identifier
      - `id` string, required — Billing address ID (address_name)
      - `first_name` string — First name
      - `last_name` string — Last name
      - `company` string — Company name
      - `address1` string — Address line 1
      - `address2` string — Address line 2
      - `city` string — City
      - `state` string — State or province
      - `zip` string — ZIP or postal code
      - `country` string — Country code (ISO 3166-1 alpha-2)
      - `phone` string — Phone number
      - `email` string, email — Email address
      - `fax` string — Fax number
      - `priority` integer, nullable — Priority of the billing address
      - `payment_details` union — Payment method details. Exactly one variant: raw card data, ACH (check) data, **payment_token**, Apple Pay encrypted payload, or Google Pay encrypted payload. Do not combine fields from different variants.
        - object — Non-tokenized credit card data.
          - `card_number` string, required — Credit card number
          - `card_exp` string, required — Credit card expiration date. Format: `MMYY`
          - `card_cvv` string — The card security code.
        - object — Bank account (ACH) details for this transaction.
          - `check_name` string, required — The name on the customer's ACH account
          - `check_aba` number, required — The customer's bank routing number
          - `check_account` number, required — The customer's bank account number
          - `account_type` 'checking' | 'savings', required — The type of ACH account the customer has
          - `account_holder_type` 'personal' | 'business', required — The type of ACH account the customer has
          - `sec_code` 'PPD' | 'WEB' | 'TEL' | 'CCD' | 'POP' | 'RCK', required — The Standard Entry Class code of the ACH transaction
          - `check_number` string — Check number
        - object — Single-use or vault token from Payment Component or Collect.js (not Apple Pay / Google Pay).
          - `payment_token` string, required — The tokenized version of the customer's card or check information
        - object — Encrypted payment data from the Apple Pay SDK.
          - `applepay_payment_data` string, required — The encrypted token created when integration directly to the Apple Pay SDK
        - object — Encrypted payment data from the Google Pay SDK.
          - `googlepay_payment_data` string, required — The encrypted token created when integration directly to the Google Pay SDK
        - object — Merchant-decrypted Apple Pay payment data.
          - `decrypted_applepay_data` true, required — Merchant-decrypted Apple Pay flag.
          - `card_number` string, required — Credit card number
          - `card_exp` string, required — Credit card expiration date. Format: `MMYY`
        - object — Merchant-decrypted Google Pay payment data.
          - `decrypted_googlepay_data` true, required — Merchant-decrypted Google Pay flag.
          - `card_number` string, required — Credit card number
          - `card_exp` string, required — Credit card expiration date. Format: `MMYY`
    - `shipping` object[] — Array of shipping addresses
      - `object` 'shipping', required — Resource type identifier
      - `id` string, required — Shipping address ID (shipping_address_name)
      - `first_name` string — First name
      - `last_name` string — Last name
      - `company` string — Company name
      - `address1` string — Address line 1
      - `address2` string — Address line 2
      - `city` string — City
      - `state` string — State or province
      - `zip` string — ZIP or postal code
      - `country` string — Country code (ISO 3166-1 alpha-2)
      - `phone` string — Phone number
      - `email` string, email — Email address
      - `fax` string — Fax number
      - `priority` integer, nullable — Priority of the shipping address
  - `per_page` integer
  - `next_cursor` integer, nullable — Cursor for the next page. Use this value in the cursor parameter for the next request. Null if there are no more results.

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/nmi/apis/embedded-components-api.md) · [All operations](https://skmtc.net/nmi/apis/embedded-components-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmi/embedded-components-api/versions/45c2ecda3685/schema)