---
title: "Gets the IoT Edge device list."
method: GET
path: "/api/edge/devices"
tags: ["IoT Edge Devices"]
---

# Gets the IoT Edge device list.

`GET /api/edge/devices`

## Query parameters

- `searchText` string
- `searchStatus` boolean
- `pageSize` integer
- `pageNumber` integer
- `orderBy` string[]
- `modelId` string
- `labels` string[]

## Response `200`

Success

- IoTEdgeListItemPaginationResult — Class representing the page results.
  - `items` IoTEdgeListItem[], nullable — The current page items.
    - `deviceId` string, required — The device identifier.
    - `deviceName` string, nullable — The device status.
    - `status` string, nullable — The device status.
    - `nbDevices` integer — The number of devices connected on the IoT Edge.
    - `imageUrl` string, uri, nullable — The device model image Url.
    - `labels` LabelDto[], nullable — Gets the edge device labels.
      - `name` string, required
      - `color` string, required
  - `totalItems` integer — The total number of items.
  - `nextPage` string, nullable — The query next page Url.

---

[API](https://skmtc.net/cgi-fr/apis/azure-iot-hub-portal-api.md) · [All operations](https://skmtc.net/cgi-fr/apis/azure-iot-hub-portal-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cgi-fr/azure-iot-hub-portal-api/versions/ce058568b9f0/schema)