20250618 Cloud Services API Reference
“
Specifications:
- Version: 20250618
- Online Version
Product Information:
This product allows users to query the list of devices under a
specified cloud project. Users can filter the device list by
product ID and category using API requests.
Product Usage Instructions:
1. API Address:
GET: /v2.0/cloud/thing/device
2. Request Parameters:
- name: product_ids (String)
- query: categories (String)
- query: last_id (String)
- query: page_size (Integer)
3. Return Parameters:
- result: List
- success: Boolean
- t: tid
4. Request Example:
GET: /v2.0/cloud/thing/device?product_ids=h9sabcugftb***
5. Return Example:
{
tid: a8bcb54fb8e411eda71e169efc83a172,
result: [
{
sub: false,
productId: h9soglkuugftb***,
activeTime: 1659422574,
ip: 124.90.34.***,
icon: smart/icon/baydffaa6539efg/a6cdd065abcde3bfb689152eda***.png,
timeZone: +08:00,
customName: Robot Vacuum in Living Room,
isOnline: true,
lon: 20.0641,
updateTime: 1659422574,
uuid: vdevo165abcd98***,
productName: Robot Vacuum A001,
createTime: 1659422574,
name: Robot Vacuum-vdevo,
id: vdevo165abcd98***,
category: cz,
lat: 50.3029,
localKey: 06f4adf1e5fc4***
}
],
t: 1677752774750,
success: true
}
6. Error Code:
For more information, see error code.
7. Limits on API Request Frequency:
For more information, see Limits on API Request Frequency.
Frequently Asked Questions (FAQ):
- What are the maximum values for page_size parameter?
The maximum value for page_size is 20. - Can I filter the device list by multiple product IDs?
Yes, you can provide up to 5 product IDs separated by commas. - How can I check if a device is online?
The return example includes the ‘isOnline’ parameter, which
indicates whether the specified device is online.
“`
Query Devices in Project
Version: 20250618
Online Version
Contents Contents 1. API address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 2. Request parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 3. Return parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 4. Request example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 5. Return example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 6. Error code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 7. Limits on API Request Frequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
I
1API address Query the list of devices under a specified cloud project. You can filter the device list by product ID and category.
1 / 9
1. API address
1 GET: /v2.0/cloud/thing/device
1API address
2 / 9
2. Request parameter
Parameter
Type
IN
name
product_ids
String
query
categories
String
query
last_id
String
query
page_size
Integer
query
2Request parameter
Required false false
false
true
Description
The list of up to 5 product IDs, separated with commas
(,). The list of up to 5 product
categories, separated with commas
(,). The last device ID returned by the previous page. This parameter is not passed in case of the first page. The number of items returned on each page. Maximum value: 20 .
3 / 9
3. Return parameter
Parameter name result
Type List
success
Boolean
t tid Description of result Parameter name id category icon ip lat lon name
sub
uuid
Long String
Type String String String String String String String
Boolean
String 4 / 9
3Return parameter
Description The list of returned data.
Indicates whether the operation is successful.
Valid values: · true : The operation
succeeded. · false : The operation
failed. The timestamp.
The link ID.
Description The device ID. The product category of the specified device. The icon of the specified
device. The IP address of the
specified device. The latitude where the
device is located. The longitude where the
device is located. The name of the specified device. Indicates whether the specified device is a sub-
device. The universally unique identifier (UUID) of the
specified device.
Parameter name activeTime createTime updateTime
customName isOnline localKey productId
productName timeZone
Type Long Long Long String Boolean String String String String
4Request example
Description The timestamp when the
device was activated. Unit: seconds.
The timestamp when the device was paired for the first time. Unit: seconds. The timestamp when the
device was updated. Unit: seconds.
The custom name of the specified device.
Indicates whether the specified device is online.
The unique encrypted key of the specified device over LAN. The product ID of the specified device.
The product name of the specified device.
The time zone in which the specified device is
located.
5 / 9
4. Request example
4Request example
1 GET: /v2.0/cloud/thing/device?product_ids=h9sabcugftb***
6 / 9
5. Return example
5Return example
1{
2
“tid”: “a8bcb54fb8e411eda71e169efc83a172”,
3
“result”: [
4
{
5
“sub”: false,
6
“productId”: “h9soglkuugftb***”,
7
“activeTime”: 1659422574,
8
“ip”: “124.90.34.***”,
“icon”: “smart/icon/baydffaa6539efg/
9
a6cdd065abcde3bfb689152eda***.png”,
10
“timeZone”: “+08:00”,
11
“customName”: “Robot Vacuum in Living Room”,
12
“isOnline”: true,
13
“lon”: “20.0641”,
14
“updateTime”: 1659422574,
15
“uuid”: “vdevo165abcd98***”,
16
“productName”: “Robot Vacuum A001”,
17
“createTime”: 1659422574,
18
“name”: “Robot Vacuum-vdevo”,
19
“id”: “vdevo165abcd98***”,
20
“category”: “cz”,
21
“lat”: “50.3029”,
22
“localKey”: “06f4adf1e5fc4***”
23
}
24
],
25
“t”: 1677752774750,
26
“success”: true
27 }
7 / 9
6. Error code
For more information, see error code .
6Error code
8 / 9
7Limits on API Request Frequency
7. Limits on API Request Frequency
For more information, see Limits on API Request Frequency .
9 / 9
Documents / Resources
 |
tuya 20250618 Cloud Services API Reference [pdf] Instructions 20250618 Cloud Services API Reference, 20250618, Cloud Services API Reference, Services API Reference, API Reference |