Skip to main content
GET
List videos

Authorizations

X-Auth-Token
string
header
required

API key created in the dashboard or via POST /v1/api/api-keys. Keys are prefixed pn_ and do not expire until revoked.

Query Parameters

page
integer
default:1

Page number, starting at 1

Required range: x >= 1

Case-insensitive match against the title or the video ID

startDate
string<date>

Only videos uploaded on or after this date (YYYY-MM-DD)

endDate
string<date>

Only videos uploaded on or before this date (YYYY-MM-DD)

status
string

Comma-separated status codes. A video matches if it has any of them. See VideoSummary.status for the codes.

Example:

"3,4"

minDuration
integer

Minimum duration in whole seconds

Required range: x >= 0
maxDuration
integer

Maximum duration in whole seconds

Required range: x >= 0
hasCaptions
enum<string>

true returns only videos with at least one caption track, false only videos with none

Available options:
true,
false
audioStatus
enum<string>

Filter by audio extraction state. none means extraction has not been recorded.

Available options:
ready,
pending,
failed,
none
sort
enum<string>
default:newest

Sort order. Unknown values fall back to newest.

Available options:
newest,
oldest,
title,
title_desc,
longest,
shortest,
largest,
smallest
tag
string

Comma-separated tag IDs. A video matches if it has any of them.

Example:

"3,7,12"

Response

A page of videos

totalItems
integer

Total videos matching the filters

currentPage
integer
itemsPerPage
integer
Example:

10

items
object[]
totalVideos
integer

Same as totalItems