list_groups - Qobra public API documentation

Parameters

Body

string

Filter matched against the group name (case-insensitive substring) or, when it is a valid ObjectId, against the group id.

dimension

string

Filter to a single dimension (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.

archived

boolean

When True, return only archived groups; otherwise only active (non-archived) groups.

limit

integer

Page size, between 1 and 250. Defaults to 50.

offset

integer

Row offset into the result set — the number of rows to skip before this page. Pass the next_offset returned by the previous call, or None for the first page.

Response

Body

groups

object[]

Show object properties

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.

next_offset

integer

​Parameters

​Response

Parameters

Response