Search contacts (global)

Full-text search across all contacts. Part of the global search API that searches across multiple entity types.

GET /v1/search/contacts

Parameters

Query parameters

searchQuery

string

archived

boolean

minimal

boolean

exactMatch

boolean

enhanced

boolean

near

string

radiusKm

number

take

integer

fallbackNameToEmail

boolean

cursor

string

has_groups

object

Responses

200 — Successful response

Content-Type: application/json

error

boolean required

data

array<object> required

data[].id

string (uuid) required

data[].user_id

string

data[].first_name

string | null

data[].last_name

string | null

data[].full_name

string | null

data[].description

string | null

data[].job_title

string | null

data[].company

string | null

data[].education

string | null

data[].legacy_location

string | null

data[].image_url

string | null

data[].business_card_url

string | null

data[].website

string | null

data[].image_source

string | null

data[].birthday

string (date-time)

data[].birthday_year

integer | null

data[].linkedin

string | null

data[].twitter

string | null

data[].facebook

string | null

data[].instagram

string | null

data[].telegram

string | null

data[].tiktok

string | null

data[].youtube

string | null

data[].starred

boolean

data[].is_archived

boolean

data[].ignore_merge

boolean

data[].never_keep_in_touch

boolean

data[].source

string

data[].priority_tier

integer | null

data[].frequency

string | null

data[].frequency_text

string | null

data[].last_seen_at

string (date-time)

data[].last_reminder_at

string (date-time)

data[].next_reminder_at

string (date-time)

data[].first_met_at

string (date-time)

data[].first_interaction_at

string (date-time)

data[].linkedin_companies

string | null

data[].linkedin_education

string | null

data[].linkedin_enhance_date

string (date-time)

data[].linkedin_last_message_at

string (date-time)

data[].linkedin_last_message_snippet

string | null

data[].linkedin_message_link

string | null

data[].whatsapp_message_link

string | null

data[].whatsapp_message_snippet

string | null

data[].whatsapp_last_message_at

string (date-time)

data[].imessage_message_link

string | null

data[].imessage_message_snippet

string | null

data[].imessage_last_message_at

string (date-time)

data[].instagram_message_link

string | null

data[].instagram_message_snippet

string | null

data[].instagram_last_message_at

string (date-time)

data[].gmail_last_interaction_at

string (date-time)

data[].gmail_last_interaction_provider

string enum

Possible values: "GOOGLE", "OFFICE365"

data[].gmail_last_interaction_provider_id

string | null

data[].gmail_last_interaction_subject

string | null

data[].gcal_last_interaction_at

string (date-time)

data[].gcal_last_interaction_provider

string enum

Possible values: "GOOGLE", "OFFICE365"

data[].gcal_last_interaction_provider_id

string | null

data[].gcal_last_interaction_title

string | null

data[].phone_call_interaction_snippet

string | null

data[].phone_call_last_interaction_at

string (date-time)

data[].web_search_summary

any | null

data[].created_at

string (date-time)

data[].updated_at

string (date-time)

data[].geocode_attempts

integer

data[].geocode_failed_at

string (date-time)

data[]._count

object

data[]._count.groups_contacts

integer

data[].frequency_interval

any

data[].linkedin_data

object | null

data[].latitude

number | null

data[].longitude

number | null

data[].contact_emails

array<object>

data[].contact_phone_numbers

array<object>

data[].contact_birthdays

object | null

data[].contact_locations

array<object>

data[].contacts_custom_fields

array<object>

data[].legacy_contact_addresses

array<object>

data[].groups_contacts

array<object>

data[].tags_contacts

array<object>

data[].timeline_items_contacts

array<object>

data[].reminders_contacts

array<object>

data[].contact_relations_contact_relations_sourceTocontacts

array<object>

data[].contact_relations_contact_relations_destinationTocontacts

array<object>

data[].feed_items

array<object>

data[].keep_in_touch_reminders

object | null

Example

{
  "error": false,
  "data": [
    {
      "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/search/contacts \
  --header 'Authorization: Bearer YOUR_API_KEY'

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

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

List recurring reminders

Retrieve all recurring (keep-in-touch) reminders for the authenticated user. These are repeating reminders set to maintain contact with specific people.

Search notes

Full-text search across all notes and timeline entries. Part of the global search API.