Contacts
Get a contact
Retrieve a contact by ID. Email and phone relations are omitted by default; request them with `?include[contact_emails]=true` or `?include[contact_phone_numbers]=true`.
GET /v2/contacts/{contactId}
Parameters
Path parameters
contactId
string (uuid) required
Query parameters
include
object
select
object
Responses
200 — Successful response
Content-Type: application/json
data
object required
data.contact
object required
data.contact.id
string (uuid) required
data.contact.user_id
string
data.contact.first_name
string | null
data.contact.last_name
string | null
data.contact.full_name
string | null
data.contact.description
string | null
data.contact.job_title
string | null
data.contact.company
string | null
data.contact.education
string | null
data.contact.legacy_location
string | null
data.contact.image_url
string | null
data.contact.business_card_url
string | null
data.contact.website
string | null
data.contact.image_source
string | null
data.contact.birthday
string (date-time)
data.contact.birthday_year
integer | null
data.contact.linkedin
string | null
data.contact.twitter
string | null
data.contact.facebook
string | null
data.contact.instagram
string | null
data.contact.telegram
string | null
data.contact.tiktok
string | null
data.contact.youtube
string | null
data.contact.starred
boolean
data.contact.is_archived
boolean
data.contact.ignore_merge
boolean
data.contact.never_keep_in_touch
boolean
data.contact.source
string
data.contact.priority_tier
integer | null
data.contact.frequency
string | null
data.contact.frequency_text
string | null
data.contact.last_seen_at
string (date-time)
data.contact.last_reminder_at
string (date-time)
data.contact.next_reminder_at
string (date-time)
data.contact.first_met_at
string (date-time)
data.contact.first_interaction_at
string (date-time)
data.contact.linkedin_companies
string | null
data.contact.linkedin_education
string | null
data.contact.linkedin_enhance_date
string (date-time)
data.contact.linkedin_last_message_at
string (date-time)
data.contact.linkedin_last_message_snippet
string | null
data.contact.linkedin_message_link
string | null
data.contact.linkedin_urn
string | null
data.contact.linkedin_headline
string | null
data.contact.whatsapp_message_link
string | null
data.contact.whatsapp_message_snippet
string | null
data.contact.whatsapp_last_message_at
string (date-time)
data.contact.imessage_message_link
string | null
data.contact.imessage_message_snippet
string | null
data.contact.imessage_last_message_at
string (date-time)
data.contact.instagram_message_link
string | null
data.contact.instagram_message_snippet
string | null
data.contact.instagram_last_message_at
string (date-time)
data.contact.gmail_last_interaction_at
string (date-time)
data.contact.gmail_last_interaction_provider
string enum
Possible values:
"GOOGLE", "OFFICE365"data.contact.gmail_last_interaction_provider_id
string | null
data.contact.gmail_last_interaction_subject
string | null
data.contact.gcal_last_interaction_at
string (date-time)
data.contact.gcal_last_interaction_provider
string enum
Possible values:
"GOOGLE", "OFFICE365"data.contact.gcal_last_interaction_provider_id
string | null
data.contact.gcal_last_interaction_title
string | null
data.contact.phone_call_interaction_snippet
string | null
data.contact.phone_call_last_interaction_at
string (date-time)
data.contact.web_search_summary
any | null
data.contact.created_at
string (date-time)
data.contact.updated_at
string (date-time)
data.contact.geocode_attempts
integer
data.contact.geocode_failed_at
string (date-time)
data.contact._count
object
data.contact._count.groups_contacts
integer
data.contact.frequency_interval
any
data.contact.linkedin_data
object | null
data.contact.latitude
number | null
data.contact.longitude
number | null
data.contact.last_note
object | null
data.contact.last_note.id
string (uuid)
data.contact.last_note.preview
string
data.contact.last_note.event_time
string (date-time)
data.contact.last_note.emoji
string | null
data.contact.last_note.meeting_type
string | null
data.contact.contact_emails
array<object>
data.contact.contact_phone_numbers
array<object>
data.contact.contact_birthdays
object | null
data.contact.contact_locations
array<object>
data.contact.contacts_custom_fields
array<object>
data.contact.legacy_contact_addresses
array<object>
data.contact.groups_contacts
array<object>
data.contact.tags_contacts
array<object>
data.contact.timeline_items_contacts
array<object>
data.contact.reminders_contacts
array<object>
data.contact.contact_relations_contact_relations_sourceTocontacts
array<object>
data.contact.contact_relations_contact_relations_destinationTocontacts
array<object>
data.contact.feed_items
array<object>
data.contact.keep_in_touch_reminders
object | null
Example
{
"data": {
"contact": {
"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
Code samples
curl https://api.prod.getdex.com/v2/contacts/00000000-0000-0000-0000-000000000000 \
--header 'Authorization: Bearer YOUR_API_KEY'
fetch('https://api.prod.getdex.com/v2/contacts/00000000-0000-0000-0000-000000000000', {
headers: {
Authorization: 'Bearer YOUR_API_KEY'
}
})
requests.get(
"https://api.prod.getdex.com/v2/contacts/00000000-0000-0000-0000-000000000000",
headers={
"Authorization": "Bearer YOUR_API_KEY"
}
)
Delete a calendar event
Delete an event from the connected calendar by its provider event ID. Deleting an event you organize cancels it for all attendees. Returns `{ data: { affected, ids } }`. `Idempotency-Key` is optional.
List birthdays
Return every contact that has a stored birthday, as a light card projection: `{ data: { birthdays: [{ contact_id, full_name, image_url, job_title, company, birthday_month, birthday_day, birthday_year,

