contacts

Count contacts

Changed on

Return the total number of contacts for the authenticated user. Useful for displaying counts in dashboards without fetching full contact records.

get/v1/contacts/count

Request

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

Query parameters

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.

Response

Successful response

errorboolean required

Changes

  • 62f85fb89e0eRevision changes
    • 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

  • a2f71a243839Revision changes
    • info

      api operation id countContactsV1 was added

    • info

      added the non-success response with the status