Lookup Customers

Look up customers at a location using one of two mutually exclusive modes:

  • Search: set search_text (+ optional max_results) for a type-ahead query; returns any number of matches.
  • Exact lookup: set exactly one lookup key (customer_id, email, phone, external_app_id, or card_code); returns at most one match.

Note: lookup keys appear in the query string, so they are more exposed (logs, proxies, APM) than a request body and should be redacted.

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

Business Location ID of the merchant location.

Query Params
string

Mode A: free-text type-ahead query matched against customer name, email, or phone (max 256 characters).

Mode B: lookup keys must be empty when this is set.

int64

Mode A only: The maximum number of customers to return. Defaults to 25 when not specified, with a maximum allowed of 100 customers.

string

Mode B: loyalty customer ID, as issued by the location's loyalty provider.

string

Mode B: Customer's email address.

string

Mode B: Customer's phone number (format: +12345678901).

string

Mode B: External application id.

string
enum

Mode B: Type of external_app_id. Defaults to EXTERNAL_APP_TYPE_DINELOYAL_CARD. Must not be set without external_app_id.

  • EXTERNAL_APP_TYPE_DINELOYAL_CARD: DineLoyal card external app. Default for POS parity when external_app_id is set.
Allowed:
string

Mode B: Physical or virtual loyalty card code.

Responses

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