Management API Listing devices
List all the devices in your organisation.
To access the API you must provide the `bearer token`.
This will provide top level details for a device. Using the device's ID you can further control aspects of the device.
Send a GET
request to the API endpoint /api/orgs/{org-slug}/devices
Replacing {org-slug}
with your organisations slug.
You can find your slug:
- in the organisations settings page
- from the organisations API
This will return an array of device objects, for example:
[
{
"address": 0,
"channel": 0,
"description": "Description-738",
"enabled": true,
"id": "0197302f-faa4-7b73-8a82-0a0359b6c518",
"name": "Sensor-706"
},
...
]
Example:
curl -X 'GET' \
'https://iotsimhub.net/api/orgs/<org-slug>/devices' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer <token>" \
API error codes
The endpoint will return errors in the format:
{
"errors": {
"detail": <error response>
}
}
Error Response | Description |
---|---|
Unauthorized | The request was not successful because: 1.You are not authenticated. 2. You are not part of the organisation |