OpenTV ENTera & OpenTV Platform Documentation

Getting all topics

Request

To get all the available topics, send a GET request to:

Bash
http://<host>:<port>/mib/v1/topics

Note that the response can include all the devices that are subscribed to each topic. Because this can result in a very large response, the response is limited to 100 devices per topic by default.

There is a different endpoint for getting only the devices that are subscribed to a specific topic. See Getting all devices that are subscribed to a topic.

Headers

  • Content-Type: application/json

Optional parameters

  • limit – the number of records to return

  • deviceLimit – the number of devices to return per topic (default: 100)

  • 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, "managedBy":"SNS"}

  • 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="topicName,1"

    • ?sort="managedBy,1,topicName,-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,
  "topics": [
    {
      "_id": "66c85590befa42c82f3abe51",
      "topicName": "TopicForFootballNews",
      "description": "Group for client devices that are interested in football news/score updates",
      "topicARN": "arn:aws:sns:us-east-1:439108492018:tenant-tenantID-TopicForFootballNews",
      "active": true,
      "managedBy": "FCM",
      "modifiedDate": "2026-01-05T15:38:06.323Z",
      "creationDate": "2026-01-05T15:38:06.323Z",
      "modifiedBy": "test",
      "devices": [
        {
          "deviceId": "5fc9f023596f787fef9c43da",
          "topicName": "TopicForFootballNews",
          "topicId": "5fc9f023596f787fef9c43da",
          "deviceHardwareType": "Mobile",
          "deviceOS": "Android",
          "msgPlatform": "iot",
          "subscriptionArn": "arn:aws:sns:us-east-1:439108492018:app/GCM/test-app/fa8fc99e-ac53-37b5-a64c-36b3c4bc730a",
          "subscriptionStatus": true
        }
      ],
      "deviceCount": 1
    }
  ]
}

See also

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