Getting all devices

Request

To get a list of all devices that are registered with DMM, send a GET request to:

http://<host>:<port>/mib/v1/devices

Headers

• Content-Type: application/json

Optional parameters

• limit – the number of records to return

• page – the page number to return (cannot be used without limit)
  For example:

  • ?limit=10 returns the first 10 records.

  • ?limit=10&page=2 returns the second 10 records.

• offset – the number of records to skip

• filter – filters the output. A filter consists of one or more key/value pairs.
  For example,

  • ?filter={"active":true}

  • ?filter={"active":true, "deviceOS":"ANDROID7_TABLET"}

• sort – sorts the output. The sort expression consists of one or more key/value pairs, where the key is the name of the field to sort on, and the value is the order: 1 for ascending, -1 for descending.
  For example:

  • ?sort="userId,1"

  • ?sort="userId,1,deviceId,1"

• fields – the fields to include in the output.
  For example:

  • ?fields="topicName,description"

Response

A successful request returns an HTTP 200 status.

An unsuccessful request returns an HTTP 404 status.

A successful request generates a response that looks like this:

{
  "totalRecords": 1,
  "devices": [
    {
      "deviceId": "5fc9f023596f787fef9c43da",
      "deviceType": "STB",
      "accountId": "5fc9f023596f787fef9c43dc",
      "active": true,
      "deviceHardwareType": "Mobile",
      "deviceOS": "Android",
      "msgPlatform": "iot",
      "userId": "5fc9f026996ecd7fe9cd07fe",
      "queueRegistrations": [
        {
          "enabled": true,
          "lastRegistrationDate": "2026-01-06T11:51:28.153Z",
          "queueApplicationName": "arn:aws:sns:us-east-1:439108492018:app/GCM/test-app",
          "queueApplicationARN": "arn:aws:sns:us-east-1:439108492018:app/GCM/test-app",
          "queueRegistrationId": "dhWEWbW7fW8:APA91bGg2UsbUW_umaq55Gq96II0slf5ICeGgpu3bmH3BjBkKw4QshEiW7Nj71BAz0z1t0bkQ5jaVXHTihGcFk_uqfewF9MrFlA3PrVjfQ0Xv-ro8e-cn-HlpodP1Z4AehFljuoq5LB-",
          "deviceQueueEndpointARN": "arn:aws:sns:us-east-1:439108492018:app/GCM/test-app/fa8fc99e-ac53-37b5-a64c-36b3c4bc730a"
        }
      ],
      "topics": [
        [
          "GlobalTopicForAllDevices",
          "GlobalTopicForAndroidTV"
        ]
      ]
    }
  ]
}

See also

For full details of this API, see the Device Messaging Manager (DMM) API documentation v1.