---
title: "List users"
method: GET
path: "/users"
tags: ["User"]
---

# List users

`GET /users`

List a collection of users.

## Query parameters

- `filter` string
- `search` string
- `orderby` string
- `skip` integer
- `top` integer

## Response `200`

OK

- object
  - `count` integer — Total number of resource.
  - `items` object[]
    - `id` string — The unique ID of the resource.
    - `name` string — The user's account name. Only letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .). Username cannot start or end with period (.). `admin`, `system`, `administrator`, and `root` are reserved names for system admin only with case ignored.
    - `enabled` boolean — Allows temporarily disabling the extension.
    - `email` string — The email address.
    - `display_name` string — The display name of user.
    - `role` string — Roles include built-in roles and custom roles. Built-in roles roles cannot be modified. Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion. Built-in roles include: - `SystemAdmin`: the system administrator has almost all permissions. - `Replicator`: the application permissions collection. - `Dealer`: the sales manager has all sold tenant resource permissions - `Admin`: the admin has all tenant-wide resource permissions. - `StandardUser`: the user all user-wide resource permissions. - `StandardInternationalUser`: the user all user-wide resource permissions with international call permissions. - `QueueManager`: The call queue manager.
    - `mobile_phone` string — The mobile phone number of user.
    - `work_phone` string — The office phone number of user.
    - `home_phone` string — The home phone number of user.
    - `address` string — The address.
    - `department` string — The department of user.
    - `extension_number` string — The extension number.
    - `created_at` string, date_time — The RFC 3339 format is defined by The date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, 2017-07-21T17:32:28Z
    - `avatar_file_name` string — The name of the file.
    - `avatar_file_size` integer — The file size in bytes.
    - `avatar_file_url` string — The relative path to file url for file downloading.
    - `sync_type` 'Microsoft 365' — The synchronization method. Can be either: - `Microsoft 365`: Sync from Microsoft 365.

## Other responses

- `4XX` — Error

---

[API](https://skmtc.net/portsip/apis/portsip-pbx-rest-api.md) · [All operations](https://skmtc.net/portsip/apis/portsip-pbx-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portsip/portsip-pbx-rest-api/revisions/577415d4a3d5/schema)