---
title: "Lookup Contact"
method: GET
path: "/contacts/lookup"
tags: ["Contacts"]
---

# Lookup Contact

`GET /contacts/lookup`

## Request

- Base URL: `https://app.boei.help/api/v1`
- URL: `https://app.boei.help/api/v1/contacts/lookup`
- Auth: HTTP bearer

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.

## Query parameters

- `email` string: Lookup by email.
- `phone` string: Lookup by phone.

## Response `200`

- union
  - object
    - `data` object
      - `id` string
      - `email` string
      - `name` string
  - object: Not found
    - `data` string, nullable

---

[API](https://skmtc.dev/boei/apis/boei-api.md) - [All operations](https://skmtc.dev/boei/apis/boei-api/llms.txt) - [OpenAPI document](https://skmtc.dev/boei/apis/boei-api/revisions/fc439667d2d4?raw)