---
title: "List Unified Clients"
method: GET
path: "/network-monitoring/v1/clients"
tags: ["Clients"]
---

# List Unified Clients

`GET /network-monitoring/v1/clients`

This API endpoint retrieves a list of Clients, based on the query parameters provided. Clients list includes details like clientName, status, clientConnectionType, etc., The query parameters allow you to narrow down the results that meet specific criteria, ensuring you receive only the relevant data.

## Query parameters

- `site-id` string, const
- `site-name` string, const
- `serial-number` string, const
- `start-at` string, const
- `end-at` string, const
- `filter` string
- `sort` string, const
- `next` string
- `limit` integer

## Response `200`

Response schema for listing clients

- ListClients
  - `items` Client[], required — A list of network clients
    - `clientName` string — Specifies the name of the client.
    - `status` 'Connected' | 'Failed' | 'Connecting' | 'Disconnected' | 'Blocked' — Specifies the status of the client.
    - `connectedDeviceType` string — Type of connected device (AP/Switch/Gateway).
    - `clientConnectionType` 'Wired' | 'Wireless' — Specifies the client type.
    - `macAddress` string, required — Specifies the MAC address of the client.
    - `ipv4` string — Specifies the IPv4 address of the client.
    - `ipv6` string — Specifies the IPv6 address of the client.
    - `connectedDeviceSerial` string — Specifies the serial number of the connected device.
    - `connectedTo` string — Specifies the device name that the client is connected to.
    - `lastSeenAt` string, date-time — The date and time when the client was last detected in the system. If the client is online, this value will be 0.
    - `wlanName` string — Specifies the network identifier.
    - `port` string — Specifies the port to which the client is connected, or null if not applicable.
    - `role` string — Specifies the role of the client.
    - `vlanId` string — Specifies the VLAN ID associated with the client.
    - `vlanName` string — Specifies the VLAN name associated with the client.
    - `tunnelType` string — Specifies the tunnel type associated with the client. Possible values are "Port-based", "User-based", "Overlay", and "None". "None" indicates no tunnel.
    - `tunnelId` integer — Specifies the tunnel ID associated with the client.
    - `connectedAt` string, date-time — Specifies the timestamp when the client was connected.
    - `userName` string — The client's username.
    - `hostName` string — The client's hostname.
    - `wirelessSecurity` string — Specifies the wireless security protocol used by the client.
    - `clientManufacturer` string — Specifies the manufacturer of the client device.
    - `clientFunction` string — Specifies the functional category of the client device.
    - `clientVendor` string — Specifies the vendor of the client device.
    - `clientOperatingSystem` string — OS model of the client device.
    - `clientTags` string — Comma-separated tags associated with the client.
    - `clientCategory` string — Specifies the category of the client device.
    - `siteName` string — The name of the site where the client is located.
    - `siteId` string — A unique identifier for the site where the client is located.
    - `wirelessBand` string — Wireless frequency band used by the client.
    - `wirelessChannel` string — The wireless channel number on which the client is operating.
    - `bssid` string — The BSSID to which the client is connected on the device.
    - `radioMacAddress` string — The radio MAC address to which the client is connected on the device.
    - `keyManagement` string — Security mode used by the client.
    - `authenticationType` string — Authentication type used by the client to connect with the device.
    - `clientCapabilities` string — Client 802.11 capabilities.
    - `type` string, const, required — The type of the resource.
    - `id` string, const, required — Primary identifier for the resource.
    - `snr` integer — Specifies the signal-to-noise ratio (SNR) of the client's wireless connection. Higher values indicate better signal quality.
    - `mloOperMode` string — Specifies the Multi-Link Operation (MLO) mode used by the client for Wi-Fi 7 connectivity.
    - `phyType` string — Specifies the IEEE 802.11 physical layer standard used for the client's current connection.
  - `count` integer, required — The number of clients after filtering
  - `total` integer — Total number of clients
  - `next` string — Specifies the pagination cursor for the next page of resources. null if there are no further pages.

## Other responses

- `400` — Invalid input received.
- `401` — Unauthorized. Authentication credentials are required or invalid.
- `403` — Forbidden: Access is denied.
- `404` — Not Found error.
- `429` — Too Many Requests. The user has sent too many requests in a given amount of time.
- `500` — Internal Server Error. An unexpected error occurred on the server.

---

[API](https://skmtc.net/arubanetworks/apis/authorization.md) · [All operations](https://skmtc.net/arubanetworks/apis/authorization/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/arubanetworks/authorization/revisions/74c95058b11f/schema)