---
title: "List end users"
method: GET
path: "/endusers"
tags: ["Configuration - User Management"]
---

# List end users

`GET /endusers`

List a page of end users.

## Query parameters

- `page` integer
- `limit` integer
- `user_group_ids` integer[]
- `usernames` string[]

## Response `200`

OK

- PagedXiqEndUser
  - `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` XiqEndUser[] — 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)
    - `org_id` integer — The organization identifier, valid when enabling HIQ feature
    - `name` string, required — The user common name
    - `description` string — The user description
    - `email_address` string, required — The user email address
    - `phone_number` string, required — The user phone number
    - `password` string — The user password
    - `user_name` string, required — The user identifiable name or the same one from common name, emailAddress or phoneNumber
    - `organization` string — The organization name
    - `visit_purpose` string — The purpose of visit
    - `email_password_delivery` string — The email address for password delivery
    - `sms_password_delivery` string — The sms number for password delivery
    - `user_group_id` integer, required — The user group ID
    - `user_group_name` string, required — The user group name
    - `approval_type` string, required — The approval type
    - `expired_time` integer, required — The password expired time
    - `vlan_override` integer — VLAN ID override assigned to the user (range 1-4094, Optional)

---

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