---
title: "Get List of Devices"
method: GET
path: "/get_list_of_devices"
tags: ["Devices"]
---

# Get List of Devices

`GET /get_list_of_devices`

## Request

- Base URL: `https://api.developer.atomberg-iot.com/v2`
- URL: `https://api.developer.atomberg-iot.com/v2/get_list_of_devices`
- Auth: API key in header `x-api-key` and HTTP bearer

Every Wi-Fi connected device on your account, with the commands each one accepts.

`supported_commands` is built from the same rules the API uses to check commands, so it always matches what the API accepts. Reading it is better than hard-coding a list of commands.

## Request

No query parameters and no request body. Only the two headers below.

| Where | Name | Required | Value |
| --- | --- | --- | --- |
| Header | `x-api-key` | Yes | Your developer API key. |
| Header | `Authorization` | Yes | `Bearer <access_token>` |

## Response

Returns every Wi-Fi connected device on your account, in all your homes. This includes fans, water purifiers and smart locks. Use `device_type` to tell them apart.

A lock has `device_type: "lock"` and an empty `supported_commands` list, because locks do not accept commands through this API. Use a lock's `device_id` with 'Get Device State' and 'Get Lock Dynamic PIN'.

```json
{
  "status": "Success",
  "message": {
    "devices_list": [
      {
        "device_id": "6867258b9d78",
        "name": "Bedroom Fan",
        "series": "I1",
        "model": "Aris Starlight",
        "color": "Sand White",
        "room": "Bedroom",
        "device_type": "fan",
        "metadata": {},
        "supported_commands": [
          { "command": "power", "accepts": "true or false" },
          { "command": "speed", "accepts": "an integer from 1 to 6" },
          { "command": "sleep", "accepts": "true or false" }
        ]
      },
      {
        "device_id": "a0764ee4210c",
        "name": "Kitchen Purifier",
        "series": "W2",
        "model": "Intellon",
        "room": "Kitchen",
        "device_type": "water_purifier",
        "metadata": {},
        "supported_commands": [
          { "command": "mode", "accepts": "one of 0, 1, 2, 3, 4, 10" },
          { "command": "fallback_mode", "accepts": "one of 0, 2, 3, 4" },
          { "command": "tds_threshold", "accepts": "an integer from 100 to 300" },
          { "command": "idle_sleep", "accepts": "one of 0, 1" },
          { "command": "sleep_mode", "accepts": "one of 0, 1", "requires": ["start_utc", "stop_utc"] },
          { "command": "start_utc", "accepts": "an integer from 0 to 4294967295", "sub_key_of": "sleep_mode" },
          { "command": "stop_utc", "accepts": "an integer from 0 to 4294967295", "sub_key_of": "sleep_mode" }
        ]
      }
    ]
  }
}
```

| Field | Type | Meaning |
| --- | --- | --- |
| `device_id` | string | The identifier used by every other endpoint. |
| `name` | string | The name given to the device in the Atomberg Home app. |
| `series` | string | Hardware series. It decides which commands the device accepts. |
| `model` | string | Marketing model name. |
| `color` | string | Colour or finish, as registered. |
| `room` | string | The room the device is assigned to in the app. |
| `device_type` | string | The type of device, based on its `series`: `fan`, `water_purifier` or `lock`. |
| `metadata` | object | Registration details. Contents vary by device and may be empty. |
| `supported_commands` | array | The commands this device accepts and the values for each. |

Each entry in `supported_commands` looks like this:

| Field | Type | Meaning |
| --- | --- | --- |
| `command` | string | The key to send inside `command` on 'Send Command'. |
| `accepts` | string | The values that key takes, in words. |
| `requires` | array | Other keys that must be sent in the same message. |
| `sub_key_of` | string | Shown when the key can only be sent together with another key. |

In the example above, `sleep_mode` has `requires` set to `start_utc` and `stop_utc`, and both of them have `sub_key_of: "sleep_mode"`. This means you send `start_utc` and `stop_utc` in the same message as `sleep_mode` set to 1. See "Sleep window sub-keys" under 'Send Command'.

Use `supported_commands` instead of your own list. When a firmware update
adds a feature, it appears here. New devices also work without any change to
your code.

Fields other than `device_id` and `series` come from when the device was
registered, so an older device may have fewer of them. Your code should
handle missing fields.

## Response `200`

OK

- DeviceListResponse
  - `status` string: `Success` on a 2xx, `Error` otherwise.
  - `message` object: The response data. Each endpoint has its own format.
    - `devices_list` Device[]: Every Wi-Fi connected device on the account, across all homes.
      - `device_id` string: Use this in every other endpoint.
      - `name` string: The name given to the device in the Atomberg Home app.
      - `series` string: Hardware series. It decides which commands the device accepts.
      - `model` string: Marketing model name, as registered.
      - `color` string: Finish or colour, as registered.
      - `room` string: The room the device is assigned to in the app.
      - `device_type` 'fan' | 'water_purifier' | 'lock': The type of device. A `lock` has an empty `supported_commands` list, because locks do not accept commands through this API.
      - `metadata` object: Extra registration details. These vary by device and may be empty.
        - `ssid` string: The network the device is joined to.
      - `supported_commands` SupportedCommand[]: The commands this device accepts and the values for each. It is built from the same rules the API uses to check commands, so it always matches. Read this instead of hard-coding a list of commands.
        - `command` string: The key to send inside the `command` object on 'Send Command'.
        - `accepts` string: The values this key takes, in words (a range, a list or a type).
        - `requires` string[]: Other keys that must be sent in the same message.
        - `sub_key_of` string: Shown when this key can only be sent together with another command.

## Other responses

- `401`: The API key or token is missing, malformed or expired, or it is the wrong kind of token.
- `403`: Developer Mode is not enabled for this account, or the user does not exist. You also get a 403 when the URL path or HTTP method is wrong.
- `429`: You have used up your API key's daily quota, or gone over the per-second limit. The daily quota resets at 00:00 UTC.
- `500`: Something failed on our side. Your request was fine. Try again after a short wait.

## Changes

- **2026-10-06** `30e1ea1bdb73`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/atomberg-iot/apis/atomberg-home-public-apis/changes/get_list_of_devices/get.md)

---

[API](https://skmtc.dev/atomberg-iot/apis/atomberg-home-public-apis.md) - [All operations](https://skmtc.dev/atomberg-iot/apis/atomberg-home-public-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/atomberg-iot/apis/atomberg-home-public-apis/revisions/35290532bede?raw)
