BOboei
Contacts

Lookup Contact

Find a contact by email or phone number.

NOTE: Pass either email or phone. When nothing matches this succeeds with "data": null rather than failing, so check for null before assuming the contact exists.

get/contacts/lookup

Request

  • Base URL
    https://app.boei.help/api/v1
  • Auth
    HTTP bearer

Query parameters

emailstring

Lookup by email.

Example:john@example.com
phonestring

Lookup by phone.

Example:+1234567890

Response

OR

Example response

{
  "data": {
    "id": "con_abc123",
    "email": "john@example.com",
    "name": "John Doe"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.