Skip to main content
List the groups of your company, with filters and pagination. Groups are a secondary hierarchy organized by dimensions (a ‘Country’ dimension holds one group per country, and so on). Each row carries the group’s dimension and its current member count; use get_group for the full member list. Rows are ordered alphabetically by group name (A→Z).

​
Parameters

Body

​
string
Filter matched against the group name (case-insensitive substring) or, when it is a valid ObjectId, against the group id.
​
string
Keep only groups in the dimension with this id — the id list_group_dimensions returns.
​
boolean
When True, return only archived groups; otherwise only active (non-archived) groups.
​
integer
Page size, between 1 and 250. Defaults to 50.
​
integer
Row offset into the result set — the number of rows to skip before this page. Any offset >= 0 is accepted; it does not have to be a multiple of limit, so you can start from an arbitrary row. Pass the next_offset returned by the previous call to walk the pages, or None for the first page.

​
Response

Body

​
object[]
​
integer