Channels

List channels

Get a list of your channels.

get/v2/channels

Request

  • Base URL: https://api.istreamplanet.com
  • URL: https://api.istreamplanet.com/v2/channels
  • Auth: authcode (defined in the document in a form this page cannot read) and m2m (defined in the document in a form this page cannot read)

Query parameters

cursorstring

Current page cursor

page_sizeinteger

Number of items to return

qstring

Search query to match against for filtering a list of channels. This searches the channel ID, name, labels, and source ID.

desired_state'ON' | 'OFF'

List channels that are ON or OFF

Response

OK

desired_state'ON' | 'OFF' required

Desired state of channel

etagstring required

Content hash

idstring required

Unique channel ID

labelsstring[] nullable

Channel Labels

namestring

Friendly channel description

orgstring required

Organization

selfstring uri

Link to this resource

Example response

[
  {
    "desired_state": "ON",
    "etag": "4bc54fd8",
    "id": "hbo-west",
    "name": "HBO West",
    "source": {
      "id": "stn-knc54ts9kazynm97",
      "name": "HBO"
    }
  }
]

Changes

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