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

# List all existing users

`GET /v1/users`

## Query parameters

- `Id` integer
- `DisplayName` string
- `Nickname` string
- `Email` string
- `PhoneNumber` string
- `Department` string
- `GroupIds` string
- `IncludeSettings` boolean
- `Q` string
- `Fields` string
- `State` integer
- `DepartmentId` integer
- `DepartmentScope` DepartmentPageSelection — Selects departments for a page-level query. The query-string value can be `all` or a comma-separated list of positive department IDs, such as `12,34`.
- `ViewType` 0 | 1 — <p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
- `Page` integer
- `ItemsPerPage` integer
- `ReturnTotalItems` boolean
- `sortCol` string
- `sortDir` string
- `isExport` boolean

## Response `200`

OK

- UserResponseModelQueryResult
  - `totalItems` integer
  - `items` UserResponseModel[], nullable
    - `id` integer
    - `email` string, nullable
    - `displayName` string, nullable
    - `nickname` string, nullable
    - `photo` string, nullable
    - `color` string, nullable
    - `loginType` 'AA==' — <p>Enum values:</p><ul><li><i>0 = Normal</i></li><li><i>1 = Admin</i></li><li><i>5 = SuperAdmin</i></li></ul>
    - `active` integer
    - `ipAddress` string, nullable
    - `gsmNumber` string, nullable
    - `phoneNumber` string, nullable
    - `status` string
    - `department` string, nullable
    - `departmentIds` string, nullable
    - `isAdmin` boolean
    - `profileId` integer, nullable
    - `profileName` string, nullable
    - `lastActivityDate` string, date-time
    - `groupIds` string, nullable
    - `groups` string, nullable
    - `autoTicketMaxAssign` integer
    - `autoDealMaxAssign` integer
    - `autoChatMaxAssign` integer
    - `userSettings` UserSettings
      - `userId` integer
      - `defaultTimezoneId` integer
      - `defaultLanguage` string, nullable
      - `defaultCurrency` string, nullable
      - `allowSuperadminAccess` integer
      - `shortcutsEnabled` integer
      - `nickname` string, nullable
      - `signature` string, nullable
      - `defaultCallExtension` string, nullable
      - `mfaEnabled` boolean — Whether user has enabled multi-factor authentication
      - `mfaMethod` 1 | 2 | 3 — Defines multi-factor authentication methods<p>Enum values:</p><ul><li><i>1 = TotpApp</i> - Time-Based One Time Password (TOTP) generator app, like Google Authenticator or Authy</li><li><i>2 = Sms</i></li><li><i>3 = Email</i></li></ul>
      - `previewSettings` string, nullable — Preview settings for deals and tickets in JSON format Example: {"deal": true, "ticket": true}

---

[API](https://skmtc.dev/infoset/apis/infoset-rest-api.md) · [All operations](https://skmtc.dev/infoset/apis/infoset-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/infoset/infoset-rest-api/revisions/f5bc39a1ac15/schema)