Channel Definition Endpoint

Channel Definition Endpoint: "/channel/id/{channel_id}"

Payload: [] (Empty)

Header: (Standard API Header)

{
    "x-api-key": "{api_key}",
    "Authorization": "{security token}",
    "Content-Type": "application/json",
}

The Channel Definition Endpoint will provide a full channel definition using the Channel ID provided.

{
  "channels": [
    {
      "owner": "auth0|56d8ef7066f60ccf22eed16d",
      "subscriber_count": 1,
      "subscribers": [
        "auth0|56d8ef7066f60ccf22eed16d"
      ],
      "created": "2021-10-06T16:17:29.380Z",
      "updated": "2021-10-06T16:17:29.380Z",
      "public": true,
      "name": "A | Corp Actions",
      "description": "Channel Description",
      "id": 88936,
      "stages": [
        {
          "not": false,
          "entities": [
            {
              "type": "entity",
              "value": 13709,
              "options": {
                "relevance": "high"
              }
            },
            {
              "type": "entity",
              "value": 13584,
              "options": {
                "relevance": "high"
              }
            },
            {
              "type": "entity",
              "value": 14267,
              "options": {
                "relevance": "high"
              }
            },
            {
              "type": "entity",
              "value": 84888,
              "options": {
                "relevance": "high"
              }
            },
            {
              "type": "entity",
              "value": 84993,
              "options": {
                "relevance": "high"
              }
            },
            {
              "type": "entity",
              "value": 13710,
              "options": {
                "relevance": "high"
              }
            },
            {
              "type": "entity",
              "value": 84572,
              "options": {
                "relevance": "high"
              }
            },
            {
              "type": "entity",
              "value": 85316,
              "options": {
                "relevance": "high"
              }
            }
          ]
        }
      ]
    }
  ]
}

The primary purpose for getting a channel definition is to pick up the stages. Keep in mind that Stages are a list of JSON structures. To read articles, you will take the stages and put them into the Payload for the read articles endpoint.

---

Last update: August 21, 2025