LIST Devices
GEThttps://api.eu1.spotflow.io/workspaces/:workspaceId/devices
LIST Devices
Request
Path Parameters
workspaceId uuidrequired
Query Parameters
siteId string
deviceCategory string
parentDataGatewayDeviceId string
deviceIdPrefix string
deviceIdContains string
continuationToken string
top int32
Possible values: >= 1 and <= 1000
Default value:
100includeActivity boolean
Default value:
falseResponses
- 200
- 404
- 423
Devices.
- application/json
- Schema
- Example (auto)
- example-1
Schema
devices object[]
totalCountint32
nextPageContinuationTokenstringnullable
{
"devices": [
{
"deviceId": "string",
"siteId": "string",
"timeZone": {
"ianaTimeZone": "string",
"windowsTimeZone": "string"
},
"registrationAttributes": {},
"parentDataGatewayDeviceId": "string",
"deviceCategory": "string",
"activity": {
"isActive": true,
"latest": {
"activityId": "string",
"dateTime": "2024-07-29T15:51:28.071Z"
}
},
"connection": {
"status": "string",
"lastChange": "2024-07-29T15:51:28.071Z"
}
}
],
"totalCount": 0,
"nextPageContinuationToken": "string"
}
{
"devices": [
{
"deviceId": "device-1",
"deviceCategory": "DirectlyConnectedDevice",
"activity": {
"isActive": false,
"latest": {
"activityId": "Cloud.DeviceRegistration",
"dateTime": "2022-04-12T21:09:02.0234059+00:00"
}
},
"connection": {
"status": "Disconnected",
"lastChange": "2023-01-09T15:02:53.5066534+00:00"
}
},
{
"deviceId": "device-2",
"deviceCategory": "DirectlyConnectedDevice",
"activity": {
"isActive": true,
"latest": {
"activityId": "Cloud.DeviceRegistration",
"dateTime": "2023-01-09T15:02:53.5066534+00:00"
}
},
"connection": {
"status": "Connected",
"lastChange": "2023-01-09T15:02:53.5066534+00:00"
}
}
],
"totalCount": 850,
"nextPageContinuationToken": "eyJMYXN0RGV2aWNlSWQiOiIwMGQ5NDZlOC1jNjk0LTQ1NzQtYWZjOS0yYTVjNjJmMDI4NjEifQ=="
}
Workspace not found.
- application/problem+json
- Schema
- Example (auto)
Schema
typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Workspace is disabled.
- application/problem+json
- Schema
- Example (auto)
Schema
typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
- curl
- python
- nodejs
- csharp
- powershell
- CURL
curl -L 'https://api.eu1.spotflow.io/workspaces/:workspaceId/devices' \
-H 'Accept: application/json'