---
title: "List portal users of the account"
method: GET
path: "/users"
tags: ["Users"]
---

# List portal users of the account

`GET /users`

## Request

- Base URL: `https://api.commpeak.com/portal`
- URL: `https://api.commpeak.com/portal/users`
- Auth: API key in header `Authorization`

Returns the enabled portal users of the account: name, email, whether the user is the account's main user, roles (`admin`, `reports`, `tech_config`, `finance`, `orders`, `support`), and support departments.

## Response `200`

Successful Response

- PortalUsersResponse: Envelope returned by `GET /portal/users`.
  - `users` PortalUserItem[], required
    - `id` integer, required: User identifier.
    - `first_name` string, nullable: First name.
    - `last_name` string, nullable: Last name.
    - `email` string, nullable: Email.
    - `main_user` boolean, nullable: Whether this is the account's main user.
    - `roles` string[], nullable: Roles: `admin`, `reports`, `tech_config`, `finance`, `orders`, `support`.
    - `support_departments` string[], nullable: Support departments.

---

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