contacts

Filter contacts

Changed on

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

post/v1/contacts/filter

Request

  • Base URL: https://api.prod.getdex.com
  • URL: https://api.prod.getdex.com/v1/contacts/filter
  • Auth: HTTP bearer

Query parameters

takeinteger
skipinteger
cursorstring

Opaque pagination cursor: the nextCursor of the previous page, passed back unchanged.

ignore_mergeboolean

Filter by the ignore_merge flag (excluded from merge suggestions).

is_starredboolean

Match starred (true) or non-starred (false) contacts.

is_team_overdueboolean

Workspace only. true: the Team cadence is overdue; false: the Team cadence exists and is not overdue. Contacts with no Team cadence match neither.

is_my_overdueboolean

Workspace only. true: the caller's cadence is overdue; false: the caller's cadence exists and is not overdue. Contacts the caller has no cadence on match neither.

is_archivedboolean

Match archived (true) or active (false) contacts. Defaults to false when omitted.

has_user_created_groupsboolean

Non-system group membership: true for at least one user-created group; false for no user-created groups, including contacts with zero memberships or only Dex system-group memberships.

has_grouping_signaltrue

Internal organize prefilter: title, company, location, or LinkedIn summary is non-null and non-empty. Whitespace-only values are removed by the organize serializer.

has_groups_onlystring[]

Exclusive group membership: the contact is in at least one of these group ids and in no group outside them. Contacts with no group never match.

known_bystring

Workspace only. An active member's user id: contacts that member has a known email, calendar or shared-note interaction with. For the caller's own id, their private notes count too.

has_location_exactstring

Location: exact string match (not fuzzy).

has_never_keep_in_touchboolean

Filter by the never_keep_in_touch flag.

has_tagstring uuid

Match contacts carrying this single tag id.

has_emailboolean

Match contacts that have (true) or lack (false) at least one email.

has_phone_numberboolean

Match contacts that have (true) or lack (false) at least one phone number.

orderByunknown
linkedin_databoolean
web_search_summaryboolean
groups_countboolean
coordinatesboolean
last_noteboolean
contact_emailsboolean
contact_phone_numbersboolean
contact_birthdaysboolean
contact_locationsboolean
contacts_custom_fieldsboolean
contacts_custom_fields_contactsboolean
legacy_contact_addressesboolean
groups_contactsboolean
tags_contactsboolean
timeline_items_contactsboolean
reminders_contactsboolean
feed_itemsboolean
keep_in_touch_remindersboolean
contact_relations_contact_relations_sourceTocontactsboolean
contact_relations_contact_relations_destinationTocontactsboolean
linkedin_databoolean
web_search_summaryboolean
groups_countboolean
coordinatesboolean
last_noteboolean
idboolean
user_idboolean
first_nameboolean
last_nameboolean
descriptionboolean
birthdayboolean
legacy_locationboolean
educationboolean
job_titleboolean
companyboolean
image_sourceboolean
image_urlboolean
starredboolean
last_seen_atboolean
last_reminder_atboolean
first_met_atboolean
first_interaction_atboolean
facebookboolean
linkedinboolean
twitterboolean
instagramboolean
created_atboolean
updated_atboolean
never_keep_in_touchboolean
telegramboolean
websiteboolean
next_reminder_atboolean
sourceboolean
is_archivedboolean
birthday_yearboolean
linkedin_enhance_dateboolean
ignore_mergeboolean
geocode_attemptsboolean
geocode_failed_atboolean
full_nameboolean
business_card_urlboolean
linkedin_companiesboolean
linkedin_educationboolean
linkedin_last_message_atboolean
linkedin_last_message_snippetboolean
linkedin_message_linkboolean
linkedin_urnboolean
linkedin_headlineboolean
whatsapp_message_linkboolean
whatsapp_message_snippetboolean
whatsapp_last_message_atboolean
frequency_textboolean
imessage_message_linkboolean
imessage_message_snippetboolean
imessage_last_message_atboolean
instagram_message_linkboolean
instagram_message_snippetboolean
instagram_last_message_atboolean
gmail_last_interaction_atboolean
gcal_last_interaction_atboolean
gmail_last_interaction_provider_idboolean
gcal_last_interaction_provider_idboolean
gmail_last_interaction_subjectboolean
gcal_last_interaction_titleboolean
phone_call_interaction_snippetboolean
phone_call_last_interaction_atboolean
tiktokboolean
youtubeboolean
gmail_last_interaction_providerboolean
gcal_last_interaction_providerboolean
priority_tierboolean
workspace_idboolean
user_edited_fieldsboolean
contact_emailsboolean
contact_phone_numbersboolean
contact_birthdaysboolean
contact_locationsboolean
contacts_custom_fieldsboolean
contacts_custom_fields_contactsboolean
legacy_contact_addressesboolean
groups_contactsboolean
tags_contactsboolean
timeline_items_contactsboolean
reminders_contactsboolean
feed_itemsboolean
keep_in_touch_remindersboolean
contact_relations_contact_relations_sourceTocontactsboolean
contact_relations_contact_relations_destinationTocontactsboolean
frequencyboolean
frequency_intervalboolean

Response

Successful response

errorboolean required

Changes

  • 62f85fb89e0eRevision changes
    • info

      added the enum value contacts_custom_fields_contacts to the property /propertyNames/ of the query request parameter include

    • info

      added the enum value contacts_custom_fields_contacts to the property /propertyNames/ of the query request parameter select

    • info

      property _or/items/custom_fields/items/value of query request parameter where list-of-types was widened by adding types boolean and number

    • info

      property custom_fields/items/value of query request parameter where list-of-types was widened by adding types boolean and number

    • info

      added the optional property /// to the response with the status

  • 453bed03b3f2Revision changes
    • info

      added the enum value user_edited_fields to the property /propertyNames/ of the query request parameter select

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status