WIwistia
Channels

Show Channel

Changed on

Returns the Channel associated with the hashedId.

Requires api token with one of the following permissions

Read all folder and media data

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token.

An expiring access token created with the all:delegate_to_contact_permissions scope and an authorization naming this channel (any permission) can also be used.

get/channels/{channelHashedId}

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/channels/{channelHashedId}
  • Auth
    HTTP bearer

Path parameters

channelHashedIdstring required

Hashed ID of the channel (e.g., "4d23503f70")

The hashed ID of the channel.

Headers

X-Wistia-API-Versionstring required

Response

Channel retrieval successful

idinteger required

The numeric id of the channel.

createdstring date-time required

The date when the channel was originally created.

descriptionstring required

The channel's description.

hashed_idstring required

A unique alphanumeric identifier for this channel.

media_countinteger required

The number of medias in the channel.

live_stream_event_countinteger

The number of live stream events in the channel.

namestring required

The display name for the channel

updatedstring date-time required

The date when the channel was last updated.

auto_publish_enabledboolean nullable

Whether episodes are automatically published when added to the channel.

podcast_enabledboolean nullable

Whether podcasting is enabled for the channel.

custom_urlstring nullable

The custom URL used when embedding the channel on your own site. Null if no custom URL is set.

cursorstring nullable

A cursor for stable pagination based on current sort_by order. You can pass this to cursor[before] or cursor[after] as a parameter to fetch the records before or after this record in the same sort order. This is only populated if records were fetched with cursor[enabled], or cursor[before] or cursor[after].

Changes