Channel Groups

Get a channel group by channel group id

This method requires the ChannelGroups:Get permission to be associated with your role.

GET

/fm/channel/groups/{channel_group_id}

curl --request GET \
  --url https://api.catch-e.com/fm/channel/groups/{channel_group_id} \
  --header 'Authorization: <api-key>'

{
  "_links": {
    "channels": {
      "href": "https://api.catch-e.com/fm/channels/?channel_group_id=100000"
    },
    "self": {
      "href": "https://api.catch-e.com/fm/channel/groups/100000"
    }
  },
  "channel_group_code": "ABC",
  "channel_group_id": "100000",
  "name": "ABC Channel Group",
  "status_flag": "active"
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Path Parameters

channel_group_idstringrequired

Channel Group to lookup

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]*$

Response

Success

_linksobject

Show child attributes

channel_group_codestring

Example: ABC

channel_group_idstring

Example: 100000

namestring

Example: ABC Channel Group

status_flagenum<string>

Available options: active, inactive

Still need help? Ask the team