Contacts

Search contacts by name

Name-only typeahead. Matches the contact's full name accent-insensitively (`f_unaccent`) and returns full contact rows in the list envelope `{ data: { contacts: [...] } }`. `query` is required — send

GET /v2/contacts/search

Responses

200 — Successful response

Content-Type: application/json

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[].linkedin_urn

string | null

data.contacts[].linkedin_headline

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[].last_note

object | null

data.contacts[].last_note.id

string (uuid)

data.contacts[].last_note.preview

string

data.contacts[].last_note.event_time

string (date-time)

data.contacts[].last_note.emoji

string | null

data.contacts[].last_note.meeting_type

string | 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

data.pagination

object

data.pagination.nextCursor

string | null

data.pagination.count

integer

Example

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

400 — Request body failed validation.

Content-Type: application/json

(body)

any

401 — Missing or invalid API key.

Content-Type: application/json

(body)

any

403 — Valid key, insufficient permission.

Content-Type: application/json

(body)

any

404 — Resource does not exist.

Content-Type: application/json

(body)

any

409 — Request conflicts with the current state of the resource.

Content-Type: application/json

(body)

any

429 — Rate limit exceeded.

Content-Type: application/json

(body)

any

500 — Unexpected server error.

Content-Type: application/json

(body)

any

List contacts with filters sent in the request body. Accepts a Prisma-shaped `where` clause, an optional geographic `near` radius, and pagination. Returns the same shape as `GET /v2/contacts/` with an

Search contacts, full

Full-capability contact search: free-text across seven fields with accent folding and similarity ranking, phone-number lookup on digits (a query that is only a phone number searches stored numbers ins

Search contacts by name

Parameters

Query parameters

Responses

200 — Successful response

400 — Request body failed validation.

401 — Missing or invalid API key.

403 — Valid key, insufficient permission.

404 — Resource does not exist.

409 — Request conflicts with the current state of the resource.

429 — Rate limit exceeded.

500 — Unexpected server error.

Code samples