API Reference
Videos
Video List

Get list of videos

Fetching video list

Listing videos is done by sending a GET request to the /videos endpoint.

curl -X GET https://app.ignitevideo.cloud/api/videos \
-H "Authorization: Bearer YOUR_TOKEN"

Query Parameters

For detailed information on all available operators and advanced filtering, see Querying. You can add the following URL query parameters to the request:

ParameterTypeDescription
pagenumberThe page number to fetch.
limitnumberThe number of videos to fetch per page.
sortstringThe field to sort by. Prefix with - for descending order.
whereobjectCustom query to filter the videos.

Example

/api/videos?page=1&limit=10&sort=-createdAt

Filtering by status

A common use case is filtering videos by their processing status:

/api/videos?where[status][equals]=COMPLETE

API Response

The response is a JSON object with the following properties:

{
  "docs": [...], // Array of video objects
  "totalDocs": number,
  "limit": number,
  "totalPages": number,
  "page": number,
  "pagingCounter": number,
  "hasPrevPage": boolean,
  "hasNextPage": boolean,
  "prevPage": number | null,
  "nextPage": number | null
}