API Reference
Explore SandboxPartner PortalMerchant Portal

List Customers

get
https://sandbox.nmi.com/api/v5/customers

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

To look up a single customer by its vault ID, use Get Customer; to look up a specific billing address, use Get Billing Address.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Never Use Real API Keys

Use Sandbox keys with the Try It feature. Do not enter production API keys when testing.

Query Params
string

Filter by first name

string

Filter by last name

string

Filter by email address

string
length between 4 and 4
^\d{4}$

Filter by the last 4 digits of the payment account number.

date

Filter customers created on or after this date. Must be a valid calendar date in YYYY-MM-DD format.

date

Filter customers created on or before this date. Must be a valid calendar date in YYYY-MM-DD format.

string
length ≤ 512

Cursor for pagination, returned as next_cursor on the previous page. Omit for the first page.

integer
1 to 100
Defaults to 10

Number of customers to return per page (default: 10, max: 100)

Responses

401

Unauthorized

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?