List Captions
list_all_captionsRetrieve caption tracks and transcripts from Wistia accounts by media ID, language, or metadata-only filters, with pagination for bulk transcript access.
Instructions
Lists captions belonging to the account. Results can be narrowed to a specific media
with media_id, or to several media and languages at once with media_ids[] and
languages[]. Each caption includes its text, so combining these filters with
pagination fetches transcripts for many media in a few requests. Pass
include=metadata to omit transcript text when only track and language
information is needed.
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 | The page number to retrieve. This cannot be combined with `cursor`, pagination. | |
| 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. | |
| include | No | Set to `metadata` to omit caption text and return only track metadata. Omitting this parameter preserves the existing response, including SRT text. | |
| sort_by | No | Ordering. When using cursor pagination (see cursor param), only `id` is supported. | id |
| media_id | No | Find captions for a particular media by providing the media hashed ID | |
| per_page | No | The number of medias per page. Use this for both offset pagination and cursor pagination. | |
| all_pages | No | Read bounded page/per_page pages; each request consumes API quota. Not a snapshot or guaranteed complete backup. | |
| languages | No | Find captions in any of these languages, using the codes returned in each caption's `language` field (for example `eng` or `spa`). When combined with `media_ids[]`, captions must match both. | |
| max_items | No | Maximum returned records with all_pages=true, default 1000. At most 100 requests; output includes continuation state. | |
| media_ids | No | Find captions belonging to any of these media hashed IDs. IDs that don't match a media the token can access are ignored rather than returning an error. | |
| sort_direction | No | Ordering Sort Direction (0 = desc, 1 = asc; default is 1) |