Contacts

Search contacts

Search contacts by name, email, company, or other text fields. Returns contacts matching the search query, ranked by relevance.

GET /v1/contacts/search

Parameters

Query parameters

fullName

string required

take

integer

cursor

string (uuid)

Responses

200 — Successful response

Content-Type: application/json

error

boolean required

data

object required

data.contacts

array<object> required

data.contacts[].id

string (uuid) required

data.contacts[].user_id

string

data.contacts[].first_name

string | null

data.contacts[].last_name

string | null

data.contacts[].full_name

string | null

data.contacts[].description

string | null

data.contacts[].job_title

string | null

data.contacts[].company

string | null

data.contacts[].education

string | null

data.contacts[].legacy_location

string | null

data.contacts[].image_url

string | null

data.contacts[].business_card_url

string | null

data.contacts[].website

string | null

data.contacts[].image_source

string | null

data.contacts[].birthday

string (date-time)

data.contacts[].birthday_year

integer | null

data.contacts[].linkedin

string | null

data.contacts[].twitter

string | null

data.contacts[].facebook

string | null

data.contacts[].instagram

string | null

data.contacts[].telegram

string | null

data.contacts[].tiktok

string | null

data.contacts[].youtube

string | null

data.contacts[].starred

boolean

data.contacts[].is_archived

boolean

data.contacts[].ignore_merge

boolean

data.contacts[].never_keep_in_touch

boolean

data.contacts[].source

string

data.contacts[].priority_tier

integer | null

data.contacts[].frequency

string | null

data.contacts[].frequency_text

string | null

data.contacts[].last_seen_at

string (date-time)

data.contacts[].last_reminder_at

string (date-time)

data.contacts[].next_reminder_at

string (date-time)

data.contacts[].first_met_at

string (date-time)

data.contacts[].first_interaction_at

string (date-time)

data.contacts[].linkedin_companies

string | null

data.contacts[].linkedin_education

string | null

data.contacts[].linkedin_enhance_date

string (date-time)

data.contacts[].linkedin_last_message_at

string (date-time)

data.contacts[].linkedin_last_message_snippet

string | null

data.contacts[].linkedin_message_link

string | null

data.contacts[].whatsapp_message_link

string | null

data.contacts[].whatsapp_message_snippet

string | null

data.contacts[].whatsapp_last_message_at

string (date-time)

data.contacts[].imessage_message_link

string | null

data.contacts[].imessage_message_snippet

string | null

data.contacts[].imessage_last_message_at

string (date-time)

data.contacts[].instagram_message_link

string | null

data.contacts[].instagram_message_snippet

string | null

data.contacts[].instagram_last_message_at

string (date-time)

data.contacts[].gmail_last_interaction_at

string (date-time)

data.contacts[].gmail_last_interaction_provider

string enum

Possible values: "GOOGLE", "OFFICE365"

data.contacts[].gmail_last_interaction_provider_id

string | null

data.contacts[].gmail_last_interaction_subject

string | null

data.contacts[].gcal_last_interaction_at

string (date-time)

data.contacts[].gcal_last_interaction_provider

string enum

Possible values: "GOOGLE", "OFFICE365"

data.contacts[].gcal_last_interaction_provider_id

string | null

data.contacts[].gcal_last_interaction_title

string | null

data.contacts[].phone_call_interaction_snippet

string | null

data.contacts[].phone_call_last_interaction_at

string (date-time)

data.contacts[].web_search_summary

any | null

data.contacts[].created_at

string (date-time)

data.contacts[].updated_at

string (date-time)

data.contacts[].geocode_attempts

integer

data.contacts[].geocode_failed_at

string (date-time)

data.contacts[]._count

object

data.contacts[]._count.groups_contacts

integer

data.contacts[].frequency_interval

any

data.contacts[].linkedin_data

object | null

data.contacts[].latitude

number | null

data.contacts[].longitude

number | null

data.contacts[].contact_emails

array<object>

data.contacts[].contact_phone_numbers

array<object>

data.contacts[].contact_birthdays

object | null

data.contacts[].contact_locations

array<object>

data.contacts[].contacts_custom_fields

array<object>

data.contacts[].legacy_contact_addresses

array<object>

data.contacts[].groups_contacts

array<object>

data.contacts[].tags_contacts

array<object>

data.contacts[].timeline_items_contacts

array<object>

data.contacts[].reminders_contacts

array<object>

data.contacts[].contact_relations_contact_relations_sourceTocontacts

array<object>

data.contacts[].contact_relations_contact_relations_destinationTocontacts

array<object>

data.contacts[].feed_items

array<object>

data.contacts[].keep_in_touch_reminders

object | null

Example

{
  "error": false,
  "data": {
    "contacts": [
      {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ]
  }
}

400

No response body.

401

No response body.

403

No response body.

404

No response body.

429

No response body.

500

No response body.

Code samples

curl 'https://api.prod.getdex.com/v1/contacts/search?fullName=string' \
  --header 'Authorization: Bearer YOUR_API_KEY'

fetch('https://api.prod.getdex.com/v1/contacts/search?fullName=string', {
  headers: {
    Authorization: 'Bearer YOUR_API_KEY'
  }
})

requests.get(
    "https://api.prod.getdex.com/v1/contacts/search",
    headers={
      "Authorization": "Bearer YOUR_API_KEY"
    },
    params={
      "fullName": "string"
    }
)

Filter contacts

Retrieve contacts matching advanced filter criteria. Accepts filter conditions in the request body, supporting the same pagination as the list endpoint.

Merge contacts

Merge two or more duplicate contacts into a single contact record. The primary contact is kept and enriched with data from the secondary contacts, which are then deleted.