Skip to main content
GET
Returns a page of the customer records on your instance, newest first. By default, archived customers are excluded.

Query Parameters

Case-insensitive substring match on walletAddress, name, externalId, referenceKey and companyUrl. Only primary wallets are searched. To find a customer by a linked wallet, use Get Customer.
string
INDIVIDUAL or COMPANY to return only that type. Any other value is ignored.
string
default:"false"
Set to true to include archived customers in results.
integer
default:"100"
Number of results per page. Values above 200 are capped at 200.
integer
default:"0"
Number of results to skip for pagination.

Response Fields

boolean
Request status
array
Customer records with the fields listed on Get Customer, without its linked wallets, members and audit entries. Each record adds two objects of its own.
object

Error Codes