Groups

List groups

Retrieve all groups for the authenticated user. Groups are collections of contacts used to organize your network (e.g., "Coworkers", "College Friends").

GET /v1/groups/

Parameters

Query parameters

orderBy

object

where

object

include

object

select

object

take

integer

cursor

string (uuid)

Responses

200 — Successful response

Content-Type: application/json

error

boolean required

data

object required

data.groups

array<any> required

Example

{
  "error": false,
  "data": {
    "groups": [
      null
    ]
  }
}

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/v1/groups/ \
  --header 'Authorization: Bearer YOUR_API_KEY'

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

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

Batch update custom field values

Set or update custom field values for multiple contacts in a single request. Useful for bulk-populating custom fields across your contact database.

Add contacts to a group

Add one or more contacts to a group by providing an array of contact IDs. Contacts that are already in the group are ignored.