List Customers

get

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

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

Query Params

string

Filter by customer vault ID (exact match)

include_partial_id_matches

boolean

If true, customer_id filter will match partial IDs

first_name

string

Filter by first name

last_name

string

Filter by last name

billing_id

string

Filter by billing address ID

shipping_id

string

Filter by shipping address ID

string

Filter by email address

account_number

string

length ≥ 3

Filter by payment account number (last 4 digits minimum)

company

string

Filter by company name

date_from

date

Filter customers created from this date (YYYY-MM-DD)

date_to

date

Filter customers created until this date (YYYY-MM-DD)

cc_expiring

boolean

Filter for credit cards expiring soon

acu_halted

boolean

Filter for customers with ACU halted status

cursor

integer

Cursor for pagination (customer transaction_id to start after). Omit for first page.

per_page

integer

1 to 100

Defaults to 10

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

Responses

401

Unauthorized

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success