Groups

List contacts in a group

Retrieve all contacts that belong to a specific group. Supports pagination for groups with many contacts.

GET /v1/groups/{groupId}/contacts

Parameters

Path parameters

groupId

string (uuid) required

Query parameters

take

integer

cursor

string (uuid)

Responses

200 — Successful response

Content-Type: application/json

error

boolean required

data

object required

data.items

array<object> required

data.items[].id

string (uuid) required

data.items[].user_id

string

data.items[].first_name

string | null

data.items[].last_name

string | null

data.items[].full_name

string | null

data.items[].description

string | null

data.items[].job_title

string | null

data.items[].company

string | null

data.items[].education

string | null

data.items[].legacy_location

string | null

data.items[].image_url

string | null

data.items[].business_card_url

string | null

data.items[].website

string | null

data.items[].image_source

string | null

data.items[].birthday

string (date-time)

data.items[].birthday_year

integer | null

data.items[].linkedin

string | null

data.items[].twitter

string | null

data.items[].facebook

string | null

data.items[].instagram

string | null

data.items[].telegram

string | null

data.items[].tiktok

string | null

data.items[].youtube

string | null

data.items[].starred

boolean

data.items[].is_archived

boolean

data.items[].ignore_merge

boolean

data.items[].never_keep_in_touch

boolean

data.items[].source

string

data.items[].priority_tier

integer | null

data.items[].frequency

string | null

data.items[].frequency_text

string | null

data.items[].last_seen_at

string (date-time)

data.items[].last_reminder_at

string (date-time)

data.items[].next_reminder_at

string (date-time)

data.items[].first_met_at

string (date-time)

data.items[].first_interaction_at

string (date-time)

data.items[].linkedin_companies

string | null

data.items[].linkedin_education

string | null

data.items[].linkedin_enhance_date

string (date-time)

data.items[].linkedin_last_message_at

string (date-time)

data.items[].linkedin_last_message_snippet

string | null

data.items[].linkedin_message_link

string | null

data.items[].whatsapp_message_link

string | null

data.items[].whatsapp_message_snippet

string | null

data.items[].whatsapp_last_message_at

string (date-time)

data.items[].imessage_message_link

string | null

data.items[].imessage_message_snippet

string | null

data.items[].imessage_last_message_at

string (date-time)

data.items[].instagram_message_link

string | null

data.items[].instagram_message_snippet

string | null

data.items[].instagram_last_message_at

string (date-time)

data.items[].gmail_last_interaction_at

string (date-time)

data.items[].gmail_last_interaction_provider

string enum

Possible values: "GOOGLE", "OFFICE365"

data.items[].gmail_last_interaction_provider_id

string | null

data.items[].gmail_last_interaction_subject

string | null

data.items[].gcal_last_interaction_at

string (date-time)

data.items[].gcal_last_interaction_provider

string enum

Possible values: "GOOGLE", "OFFICE365"

data.items[].gcal_last_interaction_provider_id

string | null

data.items[].gcal_last_interaction_title

string | null

data.items[].phone_call_interaction_snippet

string | null

data.items[].phone_call_last_interaction_at

string (date-time)

data.items[].web_search_summary

any | null

data.items[].created_at

string (date-time)

data.items[].updated_at

string (date-time)

data.items[].geocode_attempts

integer

data.items[].geocode_failed_at

string (date-time)

data.items[]._count

object

data.items[]._count.groups_contacts

integer

data.items[].frequency_interval

any

data.items[].linkedin_data

object | null

data.items[].latitude

number | null

data.items[].longitude

number | null

data.items[].contact_emails

array<object>

data.items[].contact_phone_numbers

array<object>

data.items[].contact_birthdays

object | null

data.items[].contact_locations

array<object>

data.items[].contacts_custom_fields

array<object>

data.items[].legacy_contact_addresses

array<object>

data.items[].groups_contacts

array<object>

data.items[].tags_contacts

array<object>

data.items[].timeline_items_contacts

array<object>

data.items[].reminders_contacts

array<object>

data.items[].contact_relations_contact_relations_sourceTocontacts

array<object>

data.items[].contact_relations_contact_relations_destinationTocontacts

array<object>

data.items[].feed_items

array<object>

data.items[].keep_in_touch_reminders

object | null

data.nextCursor

string | null

data.count

integer required

Example

{
  "error": false,
  "data": {
    "items": [
      {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "count": 0
  }
}

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/groups/00000000-0000-0000-0000-000000000000/contacts \
  --header 'Authorization: Bearer YOUR_API_KEY'

fetch('https://api.prod.getdex.com/v1/groups/00000000-0000-0000-0000-000000000000/contacts', {
  headers: {
    Authorization: 'Bearer YOUR_API_KEY'
  }
})

requests.get(
    "https://api.prod.getdex.com/v1/groups/00000000-0000-0000-0000-000000000000/contacts",
    headers={
      "Authorization": "Bearer YOUR_API_KEY"
    }
)

Get contact counts per group

Retrieve the number of contacts in each group. Returns a map of group IDs to their respective contact counts.

Remove contacts from a group

Remove one or more contacts from a group. The contacts themselves are not deleted — only their group membership is removed.