Get devices

This API returns an array of device objects.

This API returns an array of device objects in one of two formats depending on whether you include the paginated query parameter. If paginated=true, the API returns data using Format A, and heeds the other query parameters, most notably order_by, order, and user_uuid:

Format A

{
  "previous_page": null,
  "next_page": 2,
  "current_page_number": 1,
  "start_count_on_page": 1,
  "end_count_on_page": 5,
  "total": 9,
  "devices": [
    {
      "device": {}
    },
    {
      "device": {}
    }
  ]
}

If paginated=true, the API returns data using Format B, data that includes only devices owned by or shared with the caller, and ignores the other query parameters including order_by:

Format B

[
  {
    "device": {}
  },
  {
    "device": {}
  }
]

In general, paginated=1 is recommended because you can control quantity (per_page) and order (order_by).

NOTE:
The presence of the connection_priority key in the response body is based on the below conditions on query parameters.

• If (paginated = true) or (paginated = false & only_dsns = false & dsns_list = false & show_optimal = false), then the connection_priority key will be present in the response body.
• If (paginated = false) & (only_dsns = true or dsns_list = true or show_optimal = true), then the connection_priority key will not be present in the response body.