> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qobra.co/llms.txt
> Use this file to discover all available pages before exploring further.

# list_group_dimensions

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

<Accordion title="Body" defaultOpen>
  <ParamField body="search" type="string">
    Filter matched against the dimension name (case-insensitive substring) or,
    when it is a valid ObjectId, against the dimension id.
  </ParamField>

  <ParamField body="archived" type="boolean">
    When True, return only archived dimensions; otherwise only active
    (non-archived) dimensions.
  </ParamField>

  <ParamField body="limit" type="integer">
    Page size, between 1 and 250. Defaults to 50.
  </ParamField>

  <ParamField body="offset" type="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.
  </ParamField>
</Accordion>

## Response

<Accordion title="Body" defaultOpen>
  <ResponseField name="dimensions" type="object[]">
    <Expandable title="object properties">
      <ResponseField name="id" type="string" />

      <ResponseField name="name" type="string" />

      <ResponseField name="key" type="string">
        The dimension's stable key — the identifier used to match it when synced
        from an integration, distinct from its display name.
      </ResponseField>

      <ResponseField name="archived" type="boolean" />

      <ResponseField name="group_count" type="integer">
        Number of groups that belong to this dimension.
      </ResponseField>
    </Expandable>
  </ResponseField>

  <ResponseField name="next_offset" type="integer" />
</Accordion>
