Skip to main content
GET
List Videos

Authorizations

AccessKey
string
header
required

AccessKey based authentication

Path Parameters

libraryId
integer<int64>
required

The ID of the video library.

Query Parameters

page
integer<int32>
default:1

The page number to return, 1-based; values below 1 are treated as 1.

itemsPerPage
integer<int32>
default:100

The number of items to return per page, clamped to a range of 10-1000.

search
string | null
default:""

Filters videos by title, case-insensitive substring match.

collection
string | null
default:""

Filters videos by collection ID.

orderBy
string | null
default:date

The field to order results by. Possible values: date (newest first), title (A-Z), size (largest first), duration (longest first) — any other value falls back to date. If size or duration ordering is not available for the library, the request returns 400 Bad Request.

Response

The list of videos for the current parameters

totalItems
integer<int64>

The total number of items across all pages matching the query, not just the current page.

currentPage
integer<int64>

The current page number of the result set (1-based).

itemsPerPage
integer<int32>

The effective page size after clamping the requested value; the last page may contain fewer items.

items
object[] | null

The items on the current page, in the order returned by the query; an empty list if no results match.