Groups
List groups
List all of the authenticated user's groups. Returns the canonical list envelope: `{ data: { groups: [...] } }`. Supports `?orderBy[name]=asc|desc` and `?orderBy[number_of_contacts]=asc|desc`, plus `?
GET /v2/groups/
Parameters
Query parameters
orderBy
object
where
object
include
object
select
object
Responses
200 — Successful response
Content-Type: application/json
data
object required
data.groups
array<any> required
data.pagination
object
data.pagination.nextCursor
string | null
data.pagination.count
integer
Example
{
"data": {
"groups": [
null
]
}
}
400
No response body.
401
No response body.
403
No response body.
404
No response body.
409
No response body.
429
No response body.
500
No response body.
Code samples
curl https://api.prod.getdex.com/v2/groups/ \
--header 'Authorization: Bearer YOUR_API_KEY'
fetch('https://api.prod.getdex.com/v2/groups/', {
headers: {
Authorization: 'Bearer YOUR_API_KEY'
}
})
requests.get("https://api.prod.getdex.com/v2/groups/",
headers={
"Authorization": "Bearer YOUR_API_KEY"
}
)
Delete a group
Permanently delete a group. The contacts in the group are NOT deleted — only their `groups_contacts` membership rows and the group itself are removed. Returns the canonical bulk envelope: `{ data: { a
Create a group
Create ONE group. Accepts `name`, `emoji`, `description`, `parent_id` (for nested groups), and an optional `groups_contacts` array to add starter members. **Requires `Idempotency-Key`.** Returns `{ da