WIwistia
Channels

List Channels

Changed on

Lists all Channels belonging to an account. This endpoint can also be used to do a batch fetch based off of the hashed id.

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 a channel (any permission) can also be used; it lists the channels the token names.

get/channels

Request

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

Query parameters

enabled0 | 1

If cursor[enabled] is set to 1, the first result set will be fetched with cursor pagination enabled. This values is ignored if cursor[before] or cursor[after] are set.

beforestring

If cursor[before] is set then cursor pagination is enabled and all records before the cursor up to the per_page are returned. This feature is useful for fetching "new records", for example, in a "pull to refersh" feature when showing records in a descending order.

afterstring

If cursor[after] is set then cursor pagination is enabled and all records after the cursor up to the per_page are returned.

If cursor[enabled] is set to 1 then cursor pagination is enabled and the first set of records are fetched up to the per_page. Cursor pagination will also be turned on if cursor[before] or cursor[after] are set. Records returned will have a cursor property set which can be used to fetch more records in the same sort_by ordering. The cursor value of the last record can be used to fetch records after the current result set and the cursor of the first record can be used to fetch records before the result set.

NOTE: a cursor value is only valid if the sort_by value hasn't changed from the last fetch. For example, you cannot fetch using sort_by id and then pass that cursor value to a sort_by name.

pageinteger

Page number to retrieve

per_pageinteger

Number of channels per page

sort_by'created' | 'id' | 'updated' | 'name'

Ordering. Default is ID ASC. Note: Only 'id' and 'created' are supported when using cursor pagination.

sort_direction0 | 1

Ordering Sort Direction (0 = desc, 1 = asc; default is 1)

hashed_ids[]string[]

Find all of the channels limited to these hashed_ids.

Headers

X-Wistia-API-Versionstring required

Response

Channels 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