Groups

Get a group

Retrieve a single group by its unique ID. Returns the canonical envelope: `{ data: { group: {...} } }`. Pass `?include[is_favorite]=true` to inflate the response with a computed `is_favorite` boolean,

GET /v2/groups/{groupId}

Parameters

Path parameters

groupId

string (uuid) required

Query parameters

include

object

select

object

Responses

200 — Successful response

Content-Type: application/json

data

object required

data.group

any required

Example

{
  "data": {
    "group": 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/v2/groups/00000000-0000-0000-0000-000000000000 \
  --header 'Authorization: Bearer YOUR_API_KEY'

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

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

Bulk-delete favorites

Permanently delete multiple favorites in a single request. Returns `{ data: { affected, ids } }`. `Idempotency-Key` is optional.

Merge groups

Merge one or more source groups into the group identified by `groupId`. The destination keeps its ID, receives the final name, emoji, and de-duplicated union of contact memberships, while selected sou