HomeGuidesExamplesAPI ReferenceChangelog
Log InWistia Learning CenterWistia
API Reference
Wistia Learning CenterWistia

List Captions

get
https://api.wistia.com/modern/captions

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 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 can also be
used. It lists only the captions of media it grants the edit-transcripts
permission on; no other permission reaches a media's captions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
Query Params
string

Find captions for a particular media by providing the media hashed ID

media_ids[]
array of strings

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.

media_ids[]
languages[]
array of strings

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.

languages[]
string
enum

Set to metadata to omit caption text and return only track metadata.
Omitting this parameter preserves the existing response, including SRT text.

Allowed:
integer

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

integer

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

cursor
object

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.

string
enum
Defaults to id

Ordering. When using cursor pagination (see cursor param),
only id is supported.

Allowed:
integer
enum
Defaults to 1

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

Allowed:
Headers
string
required
Defaults to 2026-09
Responses

404

Media not found (when media_id parameter is provided)

Updated 6 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoadingā€¦
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?