v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB

Customers

List Customers

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

get/v5/customers

idstring

Filter by customer vault ID (exact match)

include_partial_id_matchesboolean

If true, customer_id filter will match partial IDs

first_namestring

Filter by first name

last_namestring

Filter by last name

billing_idstring

Filter by billing address ID

shipping_idstring

Filter by shipping address ID

emailstring email

Filter by email address

account_numberstring

Filter by payment account number (last 4 digits minimum)

companystring

Filter by company name

date_fromstring date

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

date_tostring date

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

cc_expiringboolean

Filter for credit cards expiring soon

acu_haltedboolean

Filter for customers with ACU halted status

cursorinteger

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

per_pageinteger

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

Success

per_pageinteger

next_cursorinteger nullable

Cursor for the next page. Use this value in the cursor parameter for the next request. Null if there are no more results.