Skip to main content
GET
Get Collection

Authorizations

AccessKey
string
header
required

AccessKey based authentication

Path Parameters

libraryId
integer<int64>
required

The ID of the video library.

collectionId
string
required

The unique ID of the collection.

Query Parameters

includeThumbnails
boolean
default:false

If set to true, populates PreviewImageUrls with thumbnails for videos in the collection.

Response

The details of the requested collection

videoLibraryId
integer<int64>

The video library ID that contains the collection

guid
string | null

The unique ID of the collection

name
string | null

The name of the collection

videoCount
integer<int64>

The number of on-demand videos in the collection. Live streams in the collection are not included in this count.

liveStreamCount
integer<int64>

The number of live streams in the collection. On-demand videos are not included in this count.

totalSize
integer<int64>

The total storage size of all videos in the collection, in bytes.

previewVideoIds
string | null

Comma-separated list of video GUIDs used as preview thumbnails for the collection.

previewImageUrls
string[] | null

The URLs of preview images of videos in the collection

Last modified on September 10, 2026