---
title: "Get devices on the location hierarchy."
method: GET
path: "/locations/tree/devices"
tags: ["Location"]
---

# Get devices on the location hierarchy.

`GET /locations/tree/devices`

Get devices on the location hierarchy with pagination.

## Query parameters

- `page` integer
- `limit` integer
- `locationId` integer
- `expandChildren` boolean

## Response `200`

OK

- PagedXiqLocationTreeDevice
  - `page` integer, required — The current page number
  - `count` integer, required — The element count of the current page
  - `total_pages` integer, required — The total page number based on request page size
  - `total_count` integer, required — The total element count
  - `data` XiqLocationTreeDevice[] — The data in the current page
    - `device_name` string, required — The name of the device.
    - `serial_number` string — The device serial number.
    - `mac_address` string, required — The device MAC address.
    - `device_function` string — The device function, such as AP, Router, Switch, etc.
    - `product_type` string — The product type, such as: AP_230, BR_100, NX9600, etc.
    - `ip_address` string — The device IPv4 address.
    - `location_id` integer — The location ID of the device on the location hierarchy.
    - `map_name` string — The associated background map for the device.
    - `x` number, double — The x-position of the device relative to the horizontal scale in meter.
    - `y` number, double — The y-position of the device relative to the vertical scale in meter.
    - `scale_x` number, double — The horizontal scale for the background map in meter.
    - `scale_y` number, double — The vertical scale for the background map in meter.

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)