Search customers
GET/customers/search
Find customers by an exact identifier, or by free text.
Prefer phone or email: those are exact, index-backed matches and the natural
way to answer "do I already have this company?" before creating a duplicate.
q falls back to the same substring search the list endpoint uses.
At least one of the three is required.
Request
Responses
- 200
- 400
- 401
- 403
Matches returned.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
The request was malformed, or a parameter was rejected.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No token, an expired token, or a credential that has been revoked.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
Refused. Either the credential does not hold the scope this endpoint needs (code: insufficient_scope), or the account's IP allow-list does not include the calling address (code: ip_not_allowed).
Response Headers
Correlation id for this request. Quote it when reporting a problem.