Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

A key generated from Settings → Developers, sent as Authorization: Bearer dr_live_<12 hex chars>_<64 hex chars>. Keys carry explicit scopes — each endpoint states the one it requires. The full key is shown exactly once at generation time and cannot be retrieved again; only the keyId prefix is shown afterward. A revoked key fails auth on its very next request.

Path Parameters

id
string<uuid>
required

The group id, from GET /api/preview/segments or the response of POST /api/preview/segments.

Response

The group.

A group with its rule and its live member count. Never any member data.

id
string<uuid>
required

The group id.

name
string
required

The group name.

filter
object
required

A saved rule exactly as it is stored, which is what GET /api/preview/segments/{id} returns. Unlike GroupFilter (what you may send) it has no limit on the length of a list, and its conditions can be of any type (StoredGroupCondition), because a saved group is not held to the API's rules. A group stored without a rule comes back as {}.

memberCount
integer
required

The live number of contacts in the group now (never unsubscribed contacts). A count only; the contacts themselves are never returned.

Required range: x >= 0
createdAt
string<date-time>
required

When the group was created, RFC 3339 in UTC.