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

# Get group

`GET /{sub_domain}/api/groups/{id}`

## Request

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

Retrieve a single user group by its numeric `id`, with all of its settings.

**When to use.** Read one group's full configuration, for example before updating it or before listing its assigned users and campaigns. Returns `404` if the id does not exist.

**Parameters.** `fields` (optional): a semicolon-separated list of fields to return, for example `description;ratio`. When omitted, all available fields are returned.

**Returns.** `{ "groups": [ <group> ] }`.

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

## Path parameters

- `id` integer, required: Group ID.
- `sub_domain` string, required: Dialer Name (subdomain)

## Query parameters

- `fields` string, nullable: Semicolon-separated list of fields to return, for example description;ratio.

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