List Channels
list_channelsRetrieve all Channels in a Wistia account or batch fetch specific channels using hashed IDs. Requires read permissions for folder and media data.
Instructions
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 dataTokens 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.
Read-only account operation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number to retrieve | |
| cursor | No | 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. | |
| account | No | Named private Wistia account; selects credentials, not a remote account ID. | |
| sort_by | No | Ordering. Default is ID ASC. Note: Only 'id' and 'created' are supported when using cursor pagination. | |
| per_page | No | Number of channels per page | |
| all_pages | No | Read bounded page/per_page pages; each request consumes API quota. Not a snapshot or guaranteed complete backup. | |
| max_items | No | Maximum returned records with all_pages=true, default 1000. At most 100 requests; output includes continuation state. | |
| hashed_ids | No | Find all of the channels limited to these hashed_ids. | |
| sort_direction | No | Ordering Sort Direction (0 = desc, 1 = asc; default is 1) |