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

# Get Agent Group

Use this API to fetch a single agent group by id. The response includes the full `agentIds` membership array. To list all groups without the full membership arrays, use the [List Groups](/docs/api-reference/rest-apis/v2/agents/groups/list) endpoint instead.

# Endpoint

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

# 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">
    <ParamField body="groupId" type="string" required>
      Min 1 char. Agent group id.
    </ParamField>
  </Expandable>
</ParamField>

## **Example Requests**

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

# Response

#### Success Response

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

| Field               | Type      | Description                                                                         |
| ------------------- | --------- | ----------------------------------------------------------------------------------- |
| `group.id`          | string    | Group id.                                                                           |
| `group.name`        | string    | Group name.                                                                         |
| `group.description` | string    | Group description (if set).                                                         |
| `group.agentIds`    | string\[] | Full member agent id list.                                                          |
| `group.metadata`    | object    | Stored metadata.                                                                    |
| `group.system`      | boolean   | Present and `true` on auto-provisioned system groups. Absent on groups you created. |
| `group.createdAt`   | number    | Epoch ms creation timestamp.                                                        |
| `group.updatedAt`   | number    | Epoch ms last-updated timestamp.                                                    |

<Note>
  Alongside the groups you create, the platform auto-provisions **system groups** with deterministic, human-readable ids: `copy-qa`, `seo`, `design-checks`, `performance`, and `brand-checks`. The platform classifies agents into them automatically on create. You can fetch one by passing its id as `groupId`, and it comes back with `system: true`.
</Note>

#### Failure Response

```JSON theme={null}
{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "NOT_FOUND"
  }
}
```

**Errors:** `NOT_FOUND` if the group does not exist.

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