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

# List Agent Groups

Use this API to list all agent groups in the workspace. Each row is an `IAgentGroupSummary`: instead of the full `agentIds` array, list rows carry an `agentCount` (equal to `agentIds.length`) so list payloads stay small. Clients that need the full membership list should call [Get Group](https://velt.dev/docs/api-reference/rest-apis/v2/agents/groups/get.md) by id.

> [!NOTE]
>
> The list may include **system groups** that the platform auto-creates when classifying newly created agents into default buckets (deterministic IDs such as `copy-qa`, `seo`, `design-checks`). These rows carry `system: true`; groups you create via [Create Group](https://velt.dev/docs/api-reference/rest-apis/v2/agents/groups/create.md) do not.

# Endpoint

`POST https://api.velt.dev/v2/agents/groups/list`

# Headers

**x-velt-api-key** `string` *required*

Your API key.

**x-velt-auth-token** `string` *required*

Your [Auth Token](https://velt.dev/docs/security/auth-tokens.md).

# Body

#### Params

**data** `object` *required*

**properties**

The body carries no fields other than the injected `apiKey`. Send an empty `data` object.

## **Example Requests**

```JSON theme={null}
{
  "data": {}
}
```

# Response

#### Success Response

```JSON theme={null}
{
  "result": {
    "status": "success",
    "message": "Agent groups listed successfully",
    "data": {
      "groups": [
        {
          "id": "K3mR7pQxN2vB9wLdT4sY",
          "name": "Brand QA",
          "description": "All brand-quality agents",
          "agentCount": 12,
          "metadata": {
            "apiKey": "ak_xxx",
            "organizationId": "org_001",
            "documentId": "doc_001",
            "team": "growth"
          },
          "createdAt": 1711900000000,
          "updatedAt": 1711900000000
        }
      ]
    }
  }
}
```

| Field | Type | Description |
| - | - | - |
| `groups[].id` | string | Group id. |
| `groups[].name` | string | Group name. |
| `groups[].description` | string | Group description (if set). |
| `groups[].agentCount` | number | Number of member agents (replaces the full `agentIds`). |
| `groups[].system` | boolean | `true` on platform-managed system groups (auto-created during agent classification). Absent on customer-created groups. |
| `groups[].metadata` | object | Stored metadata. |
| `groups[].createdAt` | number | Epoch ms creation timestamp. |
| `groups[].updatedAt` | number | Epoch ms last-updated timestamp. |

```js theme={null}
{
  "result": {
    "status": "success",
    "message": "Agent groups listed successfully",
    "data": {
      "groups": [
        {
          "id": "K3mR7pQxN2vB9wLdT4sY",
          "name": "Brand QA",
          "agentCount": 12,
          "metadata": { "apiKey": "ak_xxx" },
          "createdAt": 1711900000000,
          "updatedAt": 1711900000000
        }
      ]
    }
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.