UniFi: List Clients
unifi_list_clientsRead-only
List the devices currently connected to a UniFi site. Filter by name, connection type, or connected-since time to retrieve only the active clients you need, each with its ID for follow-up actions.
Instructions
List the clients currently connected to a site — the devices on your network right now, not the historical list. Each entry carries the client id (a UUID the other client tools take), its name, type, IP, MAC and when it connected. Filtering happens on the console, so a filtered call is cheaper than reading pages and discarding them here.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Match the client name, with `*` as a wildcard — e.g. "*iphone*". | |
| site | No | Which site to act on. Accepts the site UUID, its `internalReference` (the legacy 8-character name, usually "default") or its display name ("Default") — all three are resolved for you, so a guess costs nothing. Defaults to UNIFI_SITE, or to the only site when this console has just one. `unifi_list_sites` shows all three for every site. | |
| type | No | Connection type to filter by. Omit for all types. | |
| limit | No | Maximum items to return (1-200; the console rejects more). Defaults to UNIFI_PAGE_LIMIT (50). Prefer narrowing with `filter` over raising this — the console filters server-side, so a filtered request is both smaller and faster than a large page read here. | |
| filter | No | Raw server-side filter expression, applied by the console before it answers — much cheaper than fetching pages and filtering here. Syntax: `property.function(value)`, combined with `and(...)`, `or(...)` and `not(...)`. Strings take single quotes (double an embedded quote to escape it); `*` is the wildcard in `like`. Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull, contains, containsAny, containsAll. Examples: `state.eq('OFFLINE')`, `firmwareUpdatable.eq(true)`, `and(type.eq('WIRED'),name.like('*lab*'))`. The structured arguments on this tool build the common expressions for you — use this only for what they cannot express, and do not pass both. | |
| connectedSince | No | Only clients connected at or after this ISO 8601 timestamp, e.g. "2026-08-30T00:00:00Z". |