Device Smart Search

API provides the capability to search for Devices using an Elasticsearch query format. In the query string format, different attributes of Device can be combined using AND/OR operators in the query. The search results can be restricted to specific account(s) by providing the accountId(s) in addition to the query.

Required permission: device-read

Sample input request body:

Search for a specific ESN.

{
  "search": {
    "queryString": 'xxxxxxxxxx'
  }
}

Request all the devices in an account and its subaccounts.

{
  "search": {
    "queryString": "*",
    "accountId": 1110,
    "hierLevel": "All"
  }
}

Request multiple devices.

{
  "search": {
    "queryString": "esn: (xxxxxxxxxx OR xxxxxxxxxx OR xxxxxxxxxx)"
  }
}