Retrieve the user groups defined in your account.

When to use. List your user (agent) groups, or look up a group's id before fetching its details, listing its members, or updating it. To fetch a single group with all of its settings, use GET /groups/{id}.

Filtering and shape. Filter, order, limit and select fields by any response field. See Core API Concepts. Each list entry carries the group's id and name. The response is wrapped as { "groups": [ ... ] }.

Example. GET /api/groups

{
  "groups": [
    {
      "id": 211,
      "name": "2024 Training Group"
    }
  ]
}