> ## 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](/docs/api-reference/rest-apis/v2/agents/groups/get) 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](/docs/api-reference/rest-apis/v2/agents/groups/create) do not.
</Note>

# Endpoint

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

# Headers

<ParamField header="x-velt-api-key" type="string" required>
  Your API key.
</ParamField>

<ParamField header="x-velt-auth-token" type="string" required>
  Your [Auth Token](/docs/security/auth-tokens).
</ParamField>

# Body

#### Params

<ParamField body="data" type="object" required>
  <Expandable title="properties">
    The body carries no fields other than the injected `apiKey`. Send an empty `data` object.
  </Expandable>
</ParamField>

## **Example Requests**

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

# Response

#### Success Response

```JSON theme={null}
{
  "result": {
    "status": "success",
    "message": "Agent groups fetched successfully",
    "data": {
      "groups": [
        {
          "id": "grp_9f3ac2",
          "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.                                                                                        |

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