Search for customers

Retrieve customer information by the given parameter(s). See customer object definition for parameter details. The results are ordered by lastName then firstName. Each customer object will contain an additional property, customerCount, which can be used in combination with the pageNumber and pageSize query params to paginate results. [block:callout] { "type": "info", "body": "This endpoint requires a POST request despite the fact that it does not modify or create any data. This is to prevent sensitive data (such as taxId) from possibly being stored in any HTTP logs. " } [/block]

Query Params
integer
0 to 200
Defaults to 0

Which page of the results to return. Use 0 to get the first page.

integer
0 to 200
Defaults to 200

How many results to return on each page. Maximum is 200.

Body Params
string
length ≤ 64
string
length ≤ 128
string
length ≤ 50
string
length ≤ 30

No formatting (no dashes, spaces, etc).

string
length ≤ 30
string
length ≤ 30
string
length ≤ 255
date-time
accounts
array of objects
accounts
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json