Get device list
HTTP Request URL： http(s)://api.thingboot.com/{AppID}/device/list/?sign={sign}&ts={ts}
About the sign and ts definition
Or
MQTT Publish Topic： api/{AppID}/device/list
The returned results are also received on the same topic.
Request parameters
GET|POST|JSON methods are all valid
| Name | Required | Type | Description |
|---|---|---|---|
| q | No | string | Search keyword, fuzzy match for id and name
* will be ignored when passed with tag parameter |
| product | No | string | You can specify products by passing product IDs, such as 1
for multiple products, separated by delimiters ( , or | ), e.g., 1,2,3.
If multiple products are specified, the relationship between the products is "OR", as shown above: all devices under product 1 and product 2 will be listed. |
| tag | No | string | Tags can be specified by passing tag IDs, e.g., 1.
For multiple tags, separate them with a delimiter (, or |), e.g., 1,2,3.
If multiple tags are specified, the relationship between the tags is "OR". As in the above example: all devices associated with tag 1 or tag 2 will be listed. |
| group | No | string | Groups can be specified by passing group IDs, e.g., 1.
For multiple groups, separate them with a delimiter (, or |), e.g., 1,2,3.
If multiple groups are specified, the relationship between the groups is "OR". As in the above example: all devices under group 1 or group 2 will be listed. |
| page_index | No | int | Page number, default value is 1. |
| page_size | No | int | Default is 10 items. It can also be set to 20, 30, or 50. |
Return results
| Name | Type | Description |
|---|---|---|
| code | int | Return status code: 200 indicates success; for other error codes, please refer to "Global Error Codes" on the interface homepage. |
| data | string | Device List:
id: Device ID
key: Device key
name: Device name
remark: Device remark information
product: Product: id, key, title
group: Group: id, title
state: Current status values of all attributes of the device
network: Device networking status (type, name, signal strength)
online: Online status: status value, online IP address, online time (if offline, the latter two values are the IP address and time of the last online)
create: Initial creation time
tags: Device tags
create: Production date
deliver:Delivery date |
| msg | string | Return Status Information |
| page_index | int | Current Page Number |
| page_count | int | Total Page Count |
| is_more | int | Whether There Is More Data |
| total | int | Total Number of Devices Under Current Conditions |
Return example