---
title: "List Groups"
method: GET
path: "/api/v2/groups"
tags: ["Groups"]
---

# List Groups

`GET /api/v2/groups`

#### Pagination

* Cursor pagination (recommended)
* Offset pagination

See [Pagination](/api-reference/introduction/pagination/).

Returns a maximum of 100 records per page.

#### Allowed For

* Admins
* Agents

## Query parameters

- `page[before]` string
- `page[after]` string
- `page[size]` integer
- `exclude_deleted` boolean

## Response `200`

Success response

- GroupsResponse
  - `groups` GroupObject[]
    - `created_at` string, date-time — The time the group was created
    - `default` boolean — If the group is the default one for the account
    - `deleted` boolean — Deleted groups get marked as such
    - `description` string — The description of the group
    - `id` integer — Automatically assigned when creating groups
    - `is_public` boolean — If true, the group is public. If false, the group is private. You can't change a private group to a public group
    - `name` string, required — The name of the group
    - `updated_at` string, date-time — The time of the last update of the group
    - `url` string — The API url of the group

## Changes

> 29 revisions in range; 1 not diffed, 1 could not be searched.

- **2025-06-12** `edbf399da815` — 3 info
  - added the new optional `query` request parameter `page[after]`
  - added the new optional `query` request parameter `page[before]`
  - added the new optional `query` request parameter `page[size]`

[Change history](https://skmtc.dev/botbrains-io/apis/support-api/changes/api/v2/groups/get.md)

---

[API](https://skmtc.dev/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.dev/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/botbrains-io/support-api/revisions/d53eac07ba68/schema)