---
title: "Get locations of Wi-Fi clients"
method: GET
path: "/network-services/v1/wifi-clients-locations"
tags: ["Location"]
---

# Get locations of Wi-Fi clients

`GET /network-services/v1/wifi-clients-locations`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-services/v1/wifi-clients-locations`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`
- TypeScript: <https://skmtc.dev/arubanetworks/apis/authorization/docs/network-services/v1/wifi-clients-locations/get.ts> (a function with typed inputs; its response is checked against the schema)

This API provides Wi-Fi client locations using a variety of query options. Please use either `latest-location-per-client` or `latest-connected-client-mac` query parameters. For details please refer to descriptions of corresponding parameters.

## Query parameters

- `filter` string, const
- `start-at` string, date-time: Date-time in RFC 3339 format (ISO 8601) in UTC timezone with milliseconds.
- `limit` integer: Specifies the number of results to be returned. (Default: 100)
- `offset` integer: Specifies the zero-based resource offset to start the response from. (Default: 0)
- `latest-location-per-client` integer: The number of latest locations per client.
- `latest-connected-client-mac` string, mac: MAC address for the client

## Response `200`

Response returned with a list of Wifi client locations and the associated page information. Users can request the next page based on the information returned.

- ListClientLocationsForAPI: Fields appended to a list to facilitate paging.
  - `items` ClientLocation[], required
    - `type` string, const, required: Resource type.
    - `id` string, string, required: Resource ID: client MAC address and createdAt.
    - `siteId` string, const, required: Site ID associated with the client.
    - `buildingId` string, uuid: Building ID associated with the client in UUID format. Omitted if no specific building is associated with the client.
    - `floorId` string, uuid, required: Floor ID associated with the client in UUID format.
    - `macAddress` string, mac: MAC address for the client.
    - `hashedMacAddress` string, const: One way hash of the MAC address to anonymize the client.
    - `associated` boolean, required: Provides Boolean indication of whether this client is associated to an AP.
    - `associatedBssid` string, mac: Provides the associated BSSID for this client.
    - `cartesianCoordinates` CartesianCoordinateswifi, required: x and y coordinates on the plane representing the associated floorplan for this client.
      - `xInMetre` number, required: The position of the client in metres on the horizontal axis of the floorplan.
      - `yInMetre` number, required: The position of the client in metres on the vertical axis of the floorplan.
    - `geoCoordinates` GeoCoordinates: The geo-coordinates of a client in both Cartesian and Latitude/Longitude format.
      - `latitude` number: Latitude of the client location in decimal degrees with 6 decimal places of precision. The allowed range is from -90 to +90. Positive values represent latitudes north of the equator; negative values south of the equator. The value shall be relative to the WGS 84 datum.
      - `longitude` number: Longitude of the client location in decimal degrees with 6 decimal places of precision. The allowed range is from -180 to +180. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. The value shall be relative to the WGS 84 datum.
    - `clientClassification` string, const, required: System estimated classification for this client.
    - `accuracy` number, float, required: Indicates the radius of horizontal uncertainty, computed at 95%. This means the sum of the probability of potential locations contained in this uncertainty circle represents 95% of the whole venue probability. The unit of this radius is in metres.
    - `numOfReportingAps` integer, required: Number of APs that heard this client and were used to calculate the location.
    - `connected` boolean, required: Provides Boolean indication of whether this client is connected to an AP of our network.
    - `createdAt` string, date-time, required: Provides the timestamp ISO 8601 format when the computed client location is persisted in database.
  - `offset` integer: Specifies the offset of the returned page.
  - `count` integer, required: The number of objects returned in the current list.
  - `total` integer: The total number of objects contained in the datastore.

## Other responses

- `400`: Bad request error response.
- `401`: Unauthorized. Authentication credentials are required or invalid.
- `403`: Forbidden: Access is denied.
- `404`: Resource not found error response.
- `429`: Too Many Requests. The user has sent too many requests in a given amount of time.
- `500`: Internal Server Error response.

---

[API](https://skmtc.dev/arubanetworks/apis/authorization.md) - [All operations](https://skmtc.dev/arubanetworks/apis/authorization/llms.txt) - [OpenAPI document](https://skmtc.dev/arubanetworks/apis/authorization/revisions/74c95058b11f?raw)