Skip to main content
Return a single group with its full member list. Beyond the group’s identity (name, key, dimension), the result joins in every user attribution — past and present — as an email plus a YYYY-MM membership window; a null departure means the membership is still ongoing.

​
Parameters

Body

​
identifier
string
required
The group to look up. Either the group’s ObjectId, or a free-text search matched against the group name (same matching as list_groups). The search must resolve to exactly one group — a name fragment is fine; an ambiguous term that matches several groups is rejected with a clear error.
​
dimension
string
Optional dimension to disambiguate the lookup when the same name exists in several dimensions (the kind of grouping, e.g. ‘Country’). Matched against the dimension name (case-insensitive substring) or, when it is a valid ObjectId, against the dimension id.

​
Response

Body

​
id
string
​
resource_url
string
Deep link to open this group in the Qobra web app.
​
name
string
​
key
string
The group’s stable key — the identifier used to match it when synced from an integration, distinct from its display name.
​
dimension
string
Name of the dimension the group belongs to (the kind of grouping, e.g. ‘Country’ or ‘Team’). Null if the dimension is unknown.
​
archived
boolean
​
member_count
integer
Number of users currently in the group (attributions active as of today). Past and future members are excluded.
​
members
object[]
Every user attribution on the group, past and present, each with its membership window. A user with several stints appears once per attribution.