Get All Devices
GET
/api/v1/devices
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” include_legacy
Include Legacy
boolean
order_by
Order By
string
order_by_direction
string
limit
Limit
integer
offset
Offset
integer
device_type
Type of the device
Array<string>
Type of the device
Responses
Section titled “ Responses ”Successful Response
HeaderPaginatedResponse[ProducedDeviceResponse]
A list of responses with pagination information.
For backwards compatibility, this also exposes pagination using the following header format:
Access-Control-Expose-Headers: Content-Range
Content-Range: $FIRST_ITEM_IN_BATCH-$LAST_ITEM_IN_BACH/$TOTAL_ITEMS_AVAILABLE
object
status
string
message
Message
string
code
Code
string
data
required
Data
Array<object>
ProducedDeviceResponseResponse to a request for device to display on a page.
object
id
required
Id
string format: uuid
name
required
Name
string
device_type
required
Device Type
string
status
required
DeviceStatus
An enumeration.
string
average_queue_time
required
Average Queue Time
integer
max_atom_num
Max Atom Num
integer
is_emulator
required
Is Emulator
boolean
channels
Channels
Array<string>
status_message
Status Message
string
allowed_result_types
required
Array<string>
default_result_types
required
Array<string>
active
required
Active
boolean
description
Description
string
bill_usage
required
Bill Usage
boolean
pagination
required
JSendPagination
Pagination information
object
total
required
Total
integer
start
required
Start
integer
end
required
End
integer
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string