Skip to main content

Search contacts

POST 
/contacts/_search

Search contacts by email. Note: only read_from_cache=false is supported at the moment.

danger

For apollo, each unique email incurs a separate API call towards the ratelimit.

Request​

Query Parameters

    include_raw_data boolean

    Whether to include raw data fetched from the 3rd party provider.

    Example: true
    read_from_cache boolean

    Whether to read from Supaglue's Managed Destination cache or to read directly from the provider.

    NOTE: read_from_cache=true requires you to have the object synced to the Supaglue Managed Destination.

    Example: true
    page_size string

    Number of results to return per page. (Max: 100)

    Example: 100
    cursor string

    The pagination cursor value

    Example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Header Parameters

    x-customer-id stringrequired

    The customer ID that uniquely identifies the customer in your application

    Example: my-customer-1
    x-provider-name stringrequired

    The provider name

    Example: salesforce

Body

required
    filter objectrequired
    emails string[]required

    The emails to search for. This will be imeplemented as an OR search.

Responses​

Paginated Contacts

Schema
    pagination objectrequired
    next stringnullablerequired
    previous stringnullablerequired
    total_count number
    records object[]required
  • Array [
    • id stringrequired
    owner_id stringnullablerequired
    account_id stringnullable
    first_name stringnullablerequired
    last_name stringnullablerequired
    job_title stringnullablerequired
    address objectnullablerequired
    city stringnullablerequired
    country stringnullablerequired
    postal_code stringnullablerequired
    state stringnullablerequired
    street_1 stringnullablerequired
    street_2 stringnullablerequired
    email_addresses object[]required
  • Array [
    • email_address stringrequired
    email_address_type stringnullablerequired

    Possible values: [primary, personal, work]

  • ]
    • phone_numbers object[]required
  • Array [
    • phone_number stringnullablerequired
    phone_number_type stringnullablerequired

    Possible values: [primary, work, home, mobile, other]

  • ]
    • open_count numberrequired
    click_count numberrequired
    reply_count numberrequired
    bounced_count numberrequired
    created_at date-timenullablerequired
    updated_at date-timenullablerequired
    is_deleted booleanrequired
    last_modified_at date-timerequired
    raw_data object
    property name* any
  • ]
Loading...