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

# Get assigned users

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

## Request

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

Retrieve the users (agents) assigned to a user group.

**When to use.** See which agents belong to a group. Send the group `id` in the path.

**Parameters.** `fields` (optional): a semicolon-separated list of user fields to return, for example `id;username`. When omitted, the full set of user fields is returned.

**Returns.** `{ "groupUsers": [ ... ] }`, one entry per assigned user, or an empty array if the group has no users. Returns `404` if no group matches the id.

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

## Path parameters

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

## Query parameters

- `fields` string, nullable: Semicolon-separated list of user fields to return, for example id;username.

## Response `200`

Successful Response

- GroupUsersResponse
  - `groupUsers` UserResult[], required
    - `id` integer, nullable: User ID.
    - `username` string, nullable: Username.
    - `email` string, nullable: Email address.
    - `virtual_extension` integer, nullable: Virtual extension.
    - `first_name` string, nullable: First name.
    - `last_name` string, nullable: Last 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)