> ## 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_groups

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

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

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

  <ParamField body="archived" type="boolean">
    When True, return only archived groups; otherwise only active (non-archived)
    groups.
  </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="groups" type="object[]">
    <Expandable title="object properties">
      <ResponseField name="id" type="string" />

      <ResponseField name="resource_url" type="string">
        Deep link to open this group in the Qobra web app.
      </ResponseField>

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

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

      <ResponseField name="dimension" type="string">
        Name of the dimension the group belongs to (the kind of grouping, e.g.
        'Country' or 'Team'). Null if the dimension is unknown.
      </ResponseField>

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

      <ResponseField name="member_count" type="integer">
        Number of users currently in the group (attributions active as of
        today). Past and future members are excluded.
      </ResponseField>
    </Expandable>
  </ResponseField>

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