---
title: "Get all groups"
method: GET
path: "/{sub_domain}/api/groups"
tags: ["Groups"]
---

# Get all groups

`GET /{sub_domain}/api/groups`

## Request

- Base URL: `https://api.commpeak.com/dialer`
- URL: `https://api.commpeak.com/dialer/{sub_domain}/api/groups`
- Auth: API key in header `Authorization`

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](https://td.commpeak.link/Readme-dialer-api-docs). Each list entry carries the group's `id` and `name`. The response is wrapped as `{ "groups": [ ... ] }`.

**Example.** `GET /api/groups`

## Path parameters

- `sub_domain` string, required: Dialer Name (subdomain)

## Response `200`

Successful Response

- GroupResponse
  - `groups` GroupResult[], required
    - `id` integer, nullable, required: Group ID.
    - `name` string, nullable, required: Group name.

## Other responses

- `404`: Not Found
- `422`: Validation Error
- `500`: Internal Server Error

---

[API](https://skmtc.dev/commpeak/apis/commpeak-dialer-api.md) - [All operations](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/revisions/18c5edc07544?raw)