Content & ServicesOpen PlatformNew
Get Device List
Quick Guide
Prerequisites
- Make sure you have retrieved and saved your API key in the Dot. App;
The API rate limit is 10 requests per second. With the API, you can control device behavior and responses more flexibly.
Placeholders wrapped in '{{variable}}' indicate values you must replace. Fill them with your actual values and remove the '{{}}' braces.
Request Examples
GET
/api/authV2/open/devicesGenerated Code
1// Generating...Response Example
[
{
"alias": "My Dot",
"location": "Study",
"series": "quote",
"model": "quote_0",
"edition": 1,
"id": "ABCD1234ABCD"
},
{
"alias": "Desk Dot",
"location": "Office",
"series": "quote",
"model": "quote_0",
"edition": 2,
"id": "ABCD5112ABCD"
}
]Troubleshooting
Endpoint
/api/authV2/open/devices
Method
GET
Request Schema
This interface does not require a request body, only an API key in the request header.
Response Schema
Prop
Type
Devices available to this API key.
Array Items
Name assigned by the user to identify the device.
User-assigned label for where the device is placed.
Device serial number
Product family the device belongs to.
Specific model within the product family.
Hardware edition of the device.
Status Codes
| code | Meaning | Description |
|---|---|---|
200 | Success | Successfully retrieved device list |
401 | Unauthorized | Invalid or expired API key |
500 | Server Error | Internal server error |
Did this solve your problem?
Join our community