---
title: "Search contacts by email"
method: POST
path: "/api/contacts/by-email"
tags: ["Contact"]
---

# Search contacts by email

`POST /api/contacts/by-email`

## Request

- Base URL: `https://api.sponsorunited.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.sponsorunited.com/api/contacts/by-email`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sponsorunited/apis/sponsorunited-api/docs/api/contacts/by-email/post.ts> (a function with typed inputs; its response is checked against the schema)

Searches for contacts matching the provided email address. Can optionally skip sale contacts in the results

## Request body

- ContactSearchByEmailRequest
  - `email` string
  - `should_skip_sale_contacts` boolean

## Response `201`

An array with contacts with the given email.

- union[]
  - union
    - object
      - `id` integer
      - `agency_id` integer
      - `name` string
      - `position` string
      - `suggested` integer
      - `previous_suggested` integer
      - `approved` boolean
      - `notes` string
      - `birthday` string
      - `profile_picture` string
      - `work_phone` string
      - `work_phone_ext` string
      - `email` string
      - `previous_email_status` string
      - `previous_email_status_updated_at` string, date-time
      - `email_status` string
      - `email_status_updated_at` string, date-time
      - `mail_code` string
      - `linkedin` string: Linkedin profile url
      - `facebook` string: Facebook profile url
      - `twitter` string: Twitter profile url
      - `instagram` string: Instagram profile url
      - `synopsys` string
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `deleted_at` string, date-time
      - `companies_count` integer: Number of companies to which the agency contact is associated.
      - `properties_count` integer: Number of properties to which the agency contact is associated.
      - `companies` object[]
        - `id` integer
        - `name` string
      - `properties` object[]
        - `id` integer
        - `name` string
      - `last_scraped_at` string, date-time, nullable: When the LinkedIn profile was last checked by a scrape for this contact, whether or not anything changed.
      - `linkedin_data` ContactLinkedinData
        - `id` integer
        - `person_profile_id` integer
        - `type` string
        - `data` string: JSON data fetched from Linkedin, with jobs, schools, skills, general data etc.
        - `created_at` string, date-time
        - `updated_at` string, date-time
      - `contact_type` string
      - `related_entity_id` integer
      - `related_entity_name` string
      - `related_entity_logo` string
    - object
      - `id` integer
      - `property_id` integer
      - `name` string
      - `position` string
      - `suggested` integer
      - `previous_suggested` integer
      - `approved` boolean
      - `notes` string
      - `birthday` string
      - `profile_picture` string
      - `work_phone` string
      - `work_phone_ext` string
      - `email` string
      - `previous_email_status` string
      - `previous_email_status_updated_at` string, date-time
      - `email_status` string
      - `email_status_updated_at` string, date-time
      - `mail_code` string
      - `linkedin` string: Linkedin profile url
      - `facebook` string: Facebook profile url
      - `twitter` string: Twitter profile url
      - `instagram` string: Instagram profile url
      - `synopsys` string
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `deleted_at` string, date-time
      - `last_scraped_at` string, date-time, nullable: When the LinkedIn profile was last checked by a scrape for this contact, whether or not anything changed.
      - `linkedin_data` ContactLinkedinData
        - `id` integer
        - `person_profile_id` integer
        - `type` string
        - `data` string: JSON data fetched from Linkedin, with jobs, schools, skills, general data etc.
        - `created_at` string, date-time
        - `updated_at` string, date-time
      - `agencies` object[]: An array with agencies to which a contact that represents the current property belongs.
        - `id` integer
        - `name` string
        - `logo` string
        - `properties` object[]: An array with properties represented by the current contact.
          - `id` integer
          - `name` string
          - `logo` string
      - `contact_type` string
      - `related_entity_id` integer
      - `related_entity_name` string
      - `related_entity_logo` string
    - object
      - `id` integer
      - `company_id` integer
      - `name` string
      - `position` string
      - `suggested` integer
      - `previous_suggested` integer
      - `approved` boolean
      - `notes` string
      - `birthday` string
      - `profile_picture` string
      - `work_phone` string
      - `work_phone_ext` string
      - `email` string
      - `previous_email_status` string
      - `previous_email_status_updated_at` string, date-time
      - `email_status` string
      - `email_status_updated_at` string, date-time
      - `mail_code` string
      - `linkedin` string: Linkedin profile url
      - `facebook` string: Facebook profile url
      - `twitter` string: Twitter profile url
      - `instagram` string: Instagram profile url
      - `synopsys` string
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `deleted_at` string, date-time
      - `last_scraped_at` string, date-time, nullable: When the LinkedIn profile was last checked by a scrape for this contact, whether or not anything changed.
      - `linkedin_data` ContactLinkedinData
        - `id` integer
        - `person_profile_id` integer
        - `type` string
        - `data` string: JSON data fetched from Linkedin, with jobs, schools, skills, general data etc.
        - `created_at` string, date-time
        - `updated_at` string, date-time
      - `brand_name` string: The brand to which the contact belongs, when showing contacts for parent brand.
      - `brand_logo` string: The logo of the brand to which the contact belongs, when showing contacts for parent brand.
      - `brand_contact` boolean: True when showing contacts for parent brand.
      - `agencies` object[]: An array with agencies to which a contact that represents the current brand belongs.
        - `id` integer
        - `name` string
        - `logo` string
        - `brands` object[]: An array with brands represented by the current contact.
          - `id` integer
          - `name` string
          - `logo` string
      - `contact_type` string
      - `related_entity_id` integer
      - `related_entity_name` string
      - `related_entity_logo` string

---

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