WIwistia
Channel Episodes

List Channel Episodes

Changed on

Lists Channel Episodes 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 episodes of the channels the token names.

get/channel_episodes

Request

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

Query parameters

channel_idstring

The hashed ID of the channel to grab channel episodes from.

sort_by'position' | 'title' | 'created' | 'updated' | 'published_at' | 'id'

Ordering. Default is ID ASC. When using cursor pagination (see cursor param), only id and created are supported. All other sort_by options (position, title, updated, published_at) require offset pagination.

sort_direction0 | 1

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

pageinteger

The page number to retrieve. This cannot be combined with cursor, pagination.

per_pageinteger

The number of medias per page. Use this for both offset pagination and cursor pagination.

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.

media_id[]string[]

Filter by media id. Accepts either the numeric id or the hashed id of a media.

hashed_ids[]string[]

Filter by hashed id

publishedboolean

Filter by published status.

titlestring

Filter by channel episode name/title.

Headers

X-Wistia-API-Versionstring required

Response

Channel Episodes retrieval successful

idinteger

A unique numeric identifier for the channel episode.

channel_hashed_idstring required

A unique alphanumeric identifier for the channel episode's channel.

createdstring date-time required

The date when the channel episode was originally created.

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].

descriptionstring required

The channel episode's description or episode notes.

summarystring required

A short summary of the episode that is displayed when space is limited.

hashed_idstring required

A unique alphanumeric identifier for the channel episode.

media_hashed_idstring required

A unique alphanumeric identifier for the channel episode's media.

live_stream_event_hashed_idstring nullable

A unique alphanumeric identifier for the channel episode's live stream event, if any. Null when the episode is not linked to a live stream event.

publishedboolean required

Whether the channel episode has been published or is still in draft form.

publish_atstring date-time

The date and time when the episode is scheduled to be published in UTC timezone (only present when publish_status is 'scheduled').

titlestring nullable required

The title of the channel episode

updatedstring date-time required

The date when the channel was last updated.

Example response

[
  {
    "summary": "A short description.",
    "publish_at": "2024-12-31T23:59:59Z"
  }
]

Changes