Actions27
- Client Actions
- Device Actions
- Internet Access Control Actions
- Network Actions
- Site Actions
- Sites and Monitoring Actions
Client → List Active Clients
AI-generatedSummary
Retrieve the list of active clients connected to a specified Unifi site.
Inputs
- siteId (required) — Specify the site by its ID, found in the "name" field of the response from the "List Sites" operation.
- splitIntoItems — Optionally split the response data so each client is output as an individual item. Defaults to true.
Output shape
a list of client records, or a single response object if not split
When 'Split Into Items' is true (default), each active client is returned as a separate item. If false, the raw response from Unifi's API is returned as a single item.
Examples
Example 1: Retrieve all active clients for site 'default', receiving each client as a separate item.
Set siteId to 'default' and keep 'Split Into Items' enabled.