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

# Get all users

`GET /{sub_domain}/api/users`

## Request

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

Returns every user in your account.

**When to use.** Fetch the full list of users, for example to sync accounts or build a directory. To fetch a single user you already know, use `GET /users/{id}` instead.

**Parameters.** Use the `fields` query parameter to select only the fields you need. Standard list filtering, ordering and limiting by any response field are supported.

**Returns.** `{ "users": [ { ... } ] }`.

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

## Path parameters

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

## Response `200`

Successful Response

- UsersResponse
  - `users` 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

---

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