BYbymason
device-api

List devices

Fetches a page of devices registered with your account.

get/v1/default/device

Request

  • Base URL
    https://api.bymason.com
  • Auth
    API key in header Authorization

Query parameters

limitinteger

Limits the number of items in a page of results

beforestring

Request the previous page of results

afterstring

Request the next page of results

orderByCol'createdAt' | 'lastHeartbeat'

Column to sort the results

orderDir'asc' | 'desc'

Direction to order the results (i.e., ascending or descending)

searchType'partial' | 'exact'

Type of search to perform. If not provided, the search parameters will be ignored and all results returned.

searchQuerystring

Query to use for search

type'all' | 'imei' | 'serial' | 'name'

Field to apply the search query to

deviceGroupstring

Filter results based on the Deployment Group name

appsUpdatedtrue | false

Filter results based on whether the device's apps are updated

osUpdatedtrue | false

Filter results based on whether the device's OS is updated

projectUpdatedtrue | false

Filter results based on whether the device's project is updated

maxBatteryPercentnumber

Filter results based on the max, last known, battery percentage of the device

Response

List devices response

nextPagestring

Token for the next page of results. To use, set the after query paramter with this value.

prevPagestring

Token for the previous page of results. To use, set the before query parameter with this value.

Example response

{
  "data": [
    {
      "name": "Store 123 Device #2",
      "imei": "615022756680303",
      "group": {
        "self": "/default/group/myGroup",
        "name": "myGroup"
      },
      "battery": {
        "level": "100"
      },
      "serialnumber": "21BC01CF8DFF",
      "connection": {
        "dataUsage": {
          "appsDataUsage": [
            {
              "packageNames": [
                "com.myApp1",
                "com.myApp2"
              ],
              "uid": 10139
            }
          ]
        },
        "wifi": {
          "adapterMacAddress": "7e:8a:68:f2:40:10",
          "bssid": "9c:53:22:c6:a3:6f",
          "ssid": "MyNetwork"
        },
        "sim": [
          {
            "carrier": "T-Mobile - Twilio",
            "countryiso": "us",
            "iccid": "89883070000018591915",
            "mnc": "360",
            "mcc": "311"
          }
        ]
      },
      "os": {
        "configuration": {
          "product": "default",
          "project": "myProject",
          "version": "1"
        },
        "masonOS": {
          "release": "11",
          "incremental": "RD07C8FTLJFJ",
          "version": "6.2.5"
        }
      },
      "apps": [
        {
          "application": "com.example.myapplication",
          "version": "1"
        }
      ]
    }
  ],
  "nextPage": "eyJwIjoiZXlKelkyRnVTVzVrWlhoR2IzSjNZWEprSWpwdWRXeHNMQ0pzWVhOMFJYWmhiSFZoZEdWa1MyVjVJanB1ZFd4c0xDSnNhVzFwZENJNmJuVnNiSDBLIiwibCI6MTAwfQ==",
  "prevPage": "eyJuIjoiZXlKUVlXZHBibUYwYVc5dUlqcDdJbXhwYldsMElqb3hMQ0p2Wm1aelpYUWlPakY5ZlFvPSIsImwiOjF9"
}

Changes

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