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

# List all users

`GET /users`

List users with pagination.

## Query parameters

- `page` integer
- `limit` integer

## Response `200`

OK

- PagedXiqUser
  - `page` integer, required — The current page number
  - `count` integer, required — The element count of the current page
  - `total_pages` integer, required — The total page number based on request page size
  - `total_count` integer, required — The total element count
  - `data` XiqUser[] — The data in the current page
    - `id` integer, required — The unique identifier
    - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
    - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
    - `login_name` string, required — Login name, i.e. username or login Email
    - `first_name` string — The first name
    - `last_name` string — The last name, i.e. family name
    - `display_name` string — The name to display
    - `phone` string — The Phone Number
    - `job_title` string — The job title
    - `locale` string — The locale
    - `user_role` 'ADMINISTRATOR' | 'OPERATOR' | 'MONITOR' | 'HELP_DESK' | 'GUEST_MANAGEMENT' | 'OBSERVER' | 'INSTALLER' | 'APPLICATION_OPERATOR' — The user administrative role
    - `idle_timeout` integer — The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours
    - `last_login_time` string, date-time — The last login time
    - `org_id` integer — The HIQ organization ID if it is HIQ user
    - `location_ids` integer[] — The assigned location IDs.
    - `access_scope` integer — The user has access on all sites / the authorized sites. 0: VIQ_SCOPE, 1: SITE_SCOPE.
    - `viq_access_control` integer — The permissions for Site Scope user on Global Scope resources. 0: READ_WRITE, 1: READ_ONLY.

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)