---
title: "List current Agent Groups"
method: GET
path: "/agent_groups"
tags: ["agent_groups"]
---

# List current Agent Groups

`GET /agent_groups`

## Query parameters

- `limit` integer
- `offset` integer
- `name` string
- `order` 'name' | 'id'
- `dir` 'asc' | 'desc'
- `tags` object

## Response `200`

Data retrieved.

- AgentGroupPageSchema
  - `agent_groups` AgentGroupsObjSchema[], required
    - `id` string, uuid, required — Unique identifier (UUID)
    - `name` string — A unique name label
    - `description` string — User description of this Agent Group
    - `tags` object — User defined key/values that will define the members of the group by matching against Agent tags
    - `ts_created` string, date-time — Timestamp of creation
    - `matching_agents` object — Counts of agents currently matching this group
      - `total` integer — total agents matching
      - `online` integer — total agents matching which are currently online
  - `total` integer — Total number of items.
  - `offset` integer — Number of items to skip during retrieval.
  - `limit` integer — Maximum number of items to return in one page.

## Other responses

- `400` — Failed due to malformed query parameters.
- `401` — Missing or invalid access token provided.
- `404` — A non-existent entity request.
- `500` — Unexpected server-side error occurred.

---

[API](https://skmtc.net/orb-community/apis/orb-fleet.md) · [All operations](https://skmtc.net/orb-community/apis/orb-fleet/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/orb-community/orb-fleet/revisions/53154347a3c8/schema)