> ## Documentation Index
> Fetch the complete documentation index at: https://velt-raghul-agents-doc-latest.mintlify.site/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` — the full `agentIds` array is intentionally **stripped** and replaced with an `agentCount` (equal to `agentIds.length`) so list payloads stay O(1) per group. Clients that need the full membership list should call [Get Group](/api-reference/rest-apis/v2/agents/groups/get) by id.

# 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](/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": "server_org_001",
            "documentId": "server_doc_001",
            "clientOrganizationId": "org_001",
            "clientDocumentId": "doc_001"
          },
          "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[].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>