Lookup Customer (many)

Purpose

Look up customers stored in Deliverect CRM by their email/phone.

Use the Lookup Customer endpoint when a single customer profile is expected and the API should return exactly one match or an error. Use Lookup Many when the provided identifiers may match multiple customer profiles and all matching results need to be retrieved.

Body parameters

The search can be performed with one of the following fields:

  • email
  • phone

    At least one of these fields is required; if neither is provided, the API returns 422 Unprocessable Entity.
    Unlike lookup, lookup-many returns 200 OK with total: 0 and an empty items array when no profiles match.
    It never returns ambiguous_profile_lookup, making it the appropriate endpoint when a phone number may be associated with multiple profiles.

Path Params
string
required
Body Params
string
string
Responses

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