Skip to main content
GET
Search for an existing customer belonging to your business by email, phone number and/or internal_id. Use this to look up a Soap customer_id before creating a checkout, or to check whether a customer already exists. Results are always scoped to the merchant whose API key is used. Every Soap API request is authenticated with a bearer token in the Authorization header:
Your API key is in the Soap Dashboard under the Developers section. It looks like key_.... Requests with a missing or invalid API key return 422 — never 401 — with a JSON error field, usually {"error": "API key not found."}. Branch on the status code rather than the message: GET /api/v1/device_pings/latest_geo_check does not yet return the same wording. Never expose your API key in client-side code — it is server-side only.
At least one of email, phone_number or internal_id must be supplied. When more than one is provided, the customer must match all of them (AND semantics), so if a customer has changed both email and phone, search by internal_id alone. Email matching is case-insensitive; phone numbers are normalized to 10 digits (a leading +1 and any non-digit characters are stripped); internal_id is an exact match against the value you supplied when creating the customer.

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key (key_...). Used for every endpoint except POST /api/v1/device_pings.

Query Parameters

email
string

Customer email. Case-insensitive. At least one of email, phone_number or internal_id must be supplied; supplied parameters are combined with AND.

Example:

"john@acme.com"

phone_number
string

US phone number. Non-digit characters and a leading +1 are stripped; the normalized form must be 10 digits. At least one of email, phone_number or internal_id must be supplied; supplied parameters are combined with AND.

Example:

"8008001234"

internal_id
string

Your own reference for the customer, as supplied at creation. Exact match. At least one of email, phone_number or internal_id must be supplied; supplied parameters are combined with AND.

Example:

"3f1b8c4e-7c2e-4c2c-8d2f-179cf0efb36b"

Response

Search results. Always returns a results array, possibly empty.

results
object[]