List all video objects
GET {{baseUrl}}/videos?title=<string>&tags[]=<string>&tags[]=<string>&metadata[dolor_6]=<string>&metadata[ea_f]=<string>&description=<string>&liveStreamId=<string>&sortBy=updatedAt&sortOrder=asc¤tPage=1&pageSize=25
List all the video objects that are associated with the current workspace.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
title | string | The title of a specific video you want to find. The search will match exactly to what term you provide and return any videos that contain the same term as part of their titles. | |
tags[] | string | A tag is a category you create and apply to videos. You can search for videos with particular tags by listing one or more here. Only videos that have all the tags you list will be returned. | |
tags[] | string | A tag is a category you create and apply to videos. You can search for videos with particular tags by listing one or more here. Only videos that have all the tags you list will be returned. | |
metadata[dolor_6] | string | Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. Dynamic Metadata allows you to define a key that allows any value pair. | |
metadata[ea_f] | string | Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. Dynamic Metadata allows you to define a key that allows any value pair. | |
description | string | Retrieve video objects by description. | |
liveStreamId | string | Retrieve video objects that were recorded from a live stream by liveStreamId. | |
sortBy | string | Use this parameter to sort videos by the their created time, published time, updated time, or by title. | |
sortOrder | string | Use this parameter to sort results. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to A. | |
currentPage | number | Choose the number of search results to return per page. Minimum value: 1 | |
pageSize | number | Results per page. Allowed values 1-100, default is 25. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"videoId":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","publishedAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","tags":["\u003cstring\u003e","\u003cstring\u003e"],"metadata":[{"key":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"key":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"source":{"uri":"\u003cstring\u003e","type":"\u003cstring\u003e","liveStream":{"liveStreamId":"\u003cstring\u003e","links":[{"rel":"\u003cstring\u003e","uri":"\u003cstring\u003e"},{"rel":"\u003cstring\u003e","uri":"\u003cstring\u003e"}]}},"assets":{"hls":"\u003curi\u003e","iframe":"\u003cstring\u003e","player":"\u003curi\u003e","thumbnail":"\u003curi\u003e","mp4":"\u003curi\u003e"},"playerId":"\u003cstring\u003e","public":"\u003cboolean\u003e","panoramic":"\u003cboolean\u003e","mp4Support":"\u003cboolean\u003e"},{"videoId":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","publishedAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","tags":["\u003cstring\u003e","\u003cstring\u003e"],"metadata":[{"key":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"key":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"source":{"uri":"\u003cstring\u003e","type":"\u003cstring\u003e","liveStream":{"liveStreamId":"\u003cstring\u003e","links":[{"rel":"\u003cstring\u003e","uri":"\u003cstring\u003e"},{"rel":"\u003cstring\u003e","uri":"\u003cstring\u003e"}]}},"assets":{"hls":"\u003curi\u003e","iframe":"\u003cstring\u003e","player":"\u003curi\u003e","thumbnail":"\u003curi\u003e","mp4":"\u003curi\u003e"},"playerId":"\u003cstring\u003e","public":"\u003cboolean\u003e","panoramic":"\u003cboolean\u003e","mp4Support":"\u003cboolean\u003e"}],"pagination":{"links":[{"rel":"\u003cstring\u003e","uri":"\u003curi\u003e"},{"rel":"\u003cstring\u003e","uri":"\u003curi\u003e"}],"itemsTotal":"\u003cinteger\u003e","pagesTotal":"\u003cinteger\u003e","pageSize":"\u003cinteger\u003e","currentPage":"\u003cinteger\u003e","currentPageItems":"\u003cinteger\u003e"}}