Sign in
All Devices

ListDevices

Fetch a list of devices associated with the team defined by your API key.

get/devices

Query parameters

includeStateboolean

If false (the default), the device’s state is not returned, but only the device metadata. This allows you to keep the response size small if needed.

includeStateMetaboolean

If false (the default), the metadata for an IP-based device's state (i.e., timestamps reflecting each property's last updated time) are not returned.

transformstring[]

Not a true array of strings, but rather a JSONata expression such as id or { "id": id, "type": type }. For more information see Transforming JSON Responses guide.

pageLimitinteger

Maximum number of items you want returned in the response (<=100).

tagsDeviceTag[]

If specified, only return devices that have one of these tags AND are accessible by the user's Role and their assigned Device Groups (tags)

deviceIdsDeviceId[]

If specified, only return devices with matching identifiers

[
  "nrf-1234567890123456789000"
]
firmwareSupportFirmwareTypes[]

If specified, only return devices that support the given firmware types

firmwareSupportExcludeFirmwareTypes[]
subTypesThingType[]
deviceNameFuzzystring
pageNextTokenstring

If available in the initial response, use this token to retrieve the next page of items in the list. When supplying as a request parameter, use URL-encoding.

Example:4bb1f9ab35bd

Response

Ok

totalinteger

Reflects the total results returned by the query, which may be less than the total number of items available. If the response contains a pageNextToken value, you can supply the pageNextToken in the next request to get more results. The maximum value of total is the page limit of the request, or ten pages if no page limit is provided.

pageNextTokenstring

Token used to retrieve the next page of items in the list. Present in a response only if the total available results exceeds the specified limit on a page. This token does not change between requests. When supplying as a request parameter, use URL-encoding.

Example response

{
  "items": [
    {
      "id": "nrf-1234567890123456789000",
      "name": "new-device-name",
      "tags": [
        "warehouse-east",
        "temperature"
      ],
      "tenantId": "a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9",
      "firmware": {
        "supports": [
          "BOOT",
          "APP",
          "MODEM",
          "SOFTDEVICE"
        ]
      },
      "state": {
        "reported": {
          "connected": false,
          "sessionIdentifier": "ab6af4e7-32e8-4107-94d8-f096e776c077",
          "pairing": {
            "state": "paired",
            "topics": {
              "d2c": "prod/7c219c23-644e-4565-9fe7-6c56ab8bf949/m/d/nrf-123456789012345",
              "c2d": "prod/7c219c23-644e-4565-9fe7-6c56ab8bf949/m/d/nrf-123456789012345/c2d"
            }
          },
          "nrfcloud_mqtt_topic_prefix": "prod/7c219c23-644e-4565-9fe7-6c56ab8bf949/",
          "device": {
            "networkInfo": {
              "currentBand": 20,
              "supportedBands": "(1,2,3,4,5,8,12,13,17,18,19,20,25,26,28,66)\r\n",
              "areaCode": 3030,
              "mccmnc": "22801",
              "ipAddress": "10.1.10.106",
              "ueMode": 2,
              "cellID": 17513992,
              "networkMode": "LTE-M GPS"
            },
            "simInfo": {
              "uiccMode": 1,
              "iccid": "89410119346707573424",
              "imsi": "228017001757342"
            },
            "deviceInfo": {
              "modemFirmware": "mfw_nrf9160_1.2.0",
              "batteryVoltage": 5203,
              "imei": "123456789012345",
              "board": "nrf9160_pca10090",
              "appVersion": "v1.2.0-406-gbc7ade8b14a1",
              "appName": "asset_tracker"
            },
            "serviceInfo": {
              "ui": [
                "GPS",
                "FLIP",
                "TEMP",
                "HUMID",
                "AIR_PRESS",
                "RSRP"
              ],
              "fota_v1": [
                "APP",
                "MODEM"
              ]
            }
          },
          "config": {
            "GPS": {
              "enable": false
            }
          }
        },
        "desired": {
          "pairing": {
            "state": "paired",
            "topics": {
              "d2c": "prod/7c219c23-644e-4565-9fe7-6c56ab8bf949/m/d/nrf-123456789012345",
              "c2d": "prod/7c219c23-644e-4565-9fe7-6c56ab8bf949/m/d/nrf-123456789012345/c2d"
            }
          },
          "nrfcloud_mqtt_topic_prefix": "prod/7c219c23-644e-4565-9fe7-6c56ab8bf949/"
        },
        "delta": {
          "config": {
            "GPS": {
              "enable": true
            }
          }
        },
        "metadata": {
          "desired": {
            "pairing": {
              "state": {
                "timestamp": 1594295242
              },
              "topics": {
                "d2c": {
                  "timestamp": 1594295242
                },
                "c2d": {
                  "timestamp": 1594295242
                }
              }
            },
            "nrfcloud_mqtt_topic_prefix": {
              "timestamp": 1594295242
            }
          },
          "reported": {
            "connected": {
              "timestamp": 1594395957
            },
            "sessionIdentifier": {
              "timestamp": 1594395957
            },
            "pairing": {
              "state": {
                "timestamp": 1594395561
              },
              "topics": {
                "d2c": {
                  "timestamp": 1594395561
                },
                "c2d": {
                  "timestamp": 1594395561
                }
              }
            },
            "nrfcloud_mqtt_topic_prefix": {
              "timestamp": 1594395561
            },
            "device": {
              "networkInfo": {
                "currentBand": {
                  "timestamp": 1594395562
                },
                "supportedBands": {
                  "timestamp": 1594395562
                },
                "areaCode": {
                  "timestamp": 1594395562
                },
                "mccmnc": {
                  "timestamp": 1594395562
                },
                "ipAddress": {
                  "timestamp": 1594395562
                },
                "ueMode": {
                  "timestamp": 1594395562
                },
                "cellID": {
                  "timestamp": 1594395562
                },
                "networkMode": {
                  "timestamp": 1594395562
                }
              },
              "simInfo": {
                "uiccMode": {
                  "timestamp": 1594395562
                },
                "iccid": {
                  "timestamp": 1594395562
                },
                "imsi": {
                  "timestamp": 1594395562
                }
              },
              "deviceInfo": {
                "modemFirmware": {
                  "timestamp": 1594395562
                },
                "batteryVoltage": {
                  "timestamp": 1594395562
                },
                "imei": {
                  "timestamp": 1594395562
                },
                "board": {
                  "timestamp": 1594395562
                },
                "appVersion": {
                  "timestamp": 1594395562
                },
                "appName": {
                  "timestamp": 1594395562
                }
              },
              "serviceInfo": {
                "ui": [
                  {
                    "timestamp": 1594395562
                  },
                  {
                    "timestamp": 1594395562
                  },
                  {
                    "timestamp": 1594395562
                  },
                  {
                    "timestamp": 1594395562
                  },
                  {
                    "timestamp": 1594395562
                  },
                  {
                    "timestamp": 1594395562
                  }
                ],
                "fota_v1": [
                  {
                    "timestamp": 1594395562
                  },
                  {
                    "timestamp": 1594395562
                  }
                ]
              }
            },
            "config": {
              "GPS": {
                "enable": {
                  "timestamp": 1594295362
                }
              }
            }
          }
        },
        "version": 8115
      }
    }
  ],
  "total": 10,
  "pageNextToken": "4bb1f9ab35bd"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.