getGridKnownClients
Retrieve paginated list of known clients from a TP-Link Omada site, with optional time range and search filters by name, MAC, or IP.
Instructions
Get historical known clients list (paginated). Returns clients that have previously connected to the site, with optional time range and search filtering.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Start page number. Start from 1. | |
| guest | No | Filter by guest status ("true" or "false"). | |
| siteId | No | Site ID to target. If omitted, uses the default site from OMADA_SITE_ID config. Use listSites to discover available site IDs. | |
| timeEnd | No | Filter end time (Unix epoch milliseconds as string). | |
| pageSize | No | Number of entries per page. Range: 1-1000. | |
| searchKey | No | Search keyword to filter clients by name, MAC, or IP. | |
| timeStart | No | Filter start time (Unix epoch milliseconds as string). | |
| sortLastSeen | No | Sort direction for lastSeen field (e.g. "asc" or "desc"). | |
| customHeaders | No | Optional HTTP headers to include in the Omada API request (e.g. {"X-Custom-Header": "value"}). Rarely needed. |