Contact Us
API Reference

Search for customers

post
https://sandbox-api.helix.q2.com/customer/search

Retrieve customer information by the given parameter(s). See customer object definition for parameter details. Results are ordered by lastName then firstName. Each customer object includes a customerCount property, which can be used with the pageNumber and pageSize query parameters to paginate results.

ℹ️Info

This endpoint uses POST (no data is created or modified) to prevent sensitive data (e.g., taxId) from appearing in HTTP logs.


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

Updated 12 days ago

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

Updated 12 days ago