Clients

List Connected Clients

Retrieve a paginated list of all connected clients on a site, including physical devices (computers, smartphones) and active VPN connections.

<details> <summary>Filterable properties (click to expand)</summary>

Name	Type	Allowed functions
id	UUID	eq ne in notIn
type	STRING	eq ne in notIn
macAddress	STRING	isNull isNotNull eq ne in notIn
ipAddress	STRING	isNull isNotNull eq ne in notIn
connectedAt	TIMESTAMP	isNull isNotNull eq ne gt ge lt le
access.type	STRING	eq ne in notIn
access.authorized	BOOLEAN	isNull isNotNull eq ne

</details>

get/v1/sites/{siteId}/clients

Request

Base URL
https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/network/integration
Auth
none declared
TypeScript
https://skmtc.dev/ubiquiti/apis/unifi-network-api/docs/v1/sites/:siteId/clients/get.ts
A function with typed inputs. Its response is checked against the schema.

siteIdstring uuid required

offsetinteger

limitinteger

filterstring

offsetinteger required

limitinteger required

countinteger required

totalCountinteger required

{
  "limit": 25,
  "count": 10,
  "totalCount": 1000,
  "data": [
    {
      "access": {
        "type": "DEFAULT"
      }
    }
  ]
}

No recorded changes to this operation across all 1 revision of this API.