Skip to main content
Version: v3New

Lookup Contact By Email Or Phone

GET 
/contacts/lookup

Look up contacts matching an exact email or phone, scoped to a location, up to limit contacts (max 20) per page. Also matches against a contact's additional emails and additional phone numbers. Exactly one of email or phone must be provided. Paginate with nextCursor. Returns an empty contacts array if no contact matches. OAuth channel only.

Request​

Version stringrequired

API Version

Available optionsv3
locationId stringrequired

Location Id. Must be a non-empty string.

email string

Exact email to look up (case-insensitive), mutually exclusive with phone.

phone string

Exact phone number to look up, in E.164 format, mutually exclusive with email.

nextCursor string

Opaque pagination cursor returned as nextCursor by a previous request.

limit integer

Max number of contacts to return per page. Defaults to 20, capped at 20.

application/json

Successful response

Schema
    contactsobject[]

    Contacts matching the given email or phone, up to the requested limit (max 20)

    nextCursorstring

    Opaque cursor to fetch the next page. Present whenever the current page is full (limit results returned); a follow-up request with this cursor may return an empty contacts array if that was the last page.