Skip to main content
List the group dimensions of your company, with filters and pagination. A dimension is a kind of grouping — ‘Country’, ‘Team’, ‘Segment’ — and each holds one group per value (the ‘Country’ dimension holds one group per country). Reach for this to discover which dimensions exist before filtering list_groups by one; each row carries the dimension’s current group count. Rows are ordered alphabetically by dimension name (A→Z).

​
Parameters

Body

​
search
string
Filter 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 dimensions; otherwise only active (non-archived) dimensions.
​
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

​
dimensions
object[]
​
next_offset
integer