Find customer by lookup keys (read-only)

Looks up a customer without creating or updating. Resolution order matches find-or-upsert:

  1. externalId (when provided and non-empty)
  2. phone — supply phoneCountryCode, phoneAreaCode, and phoneNumber together
  3. email (when provided)

At least one of these lookup paths must be present; otherwise the API returns 400.

The retailer is resolved only from the authorizer context (retailerId is not read from query parameters).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Customer external identifier in the retailer's system.

string

Customer email address.

string

Phone country code (use together with phoneAreaCode and phoneNumber).

string

Phone area code.

string

Phone subscriber number.

Responses

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