BUbunny
Manage Collections

Get Collection List

Changed on

Returns a paginated list of collections for the library. Collections can group both videos and live streams, reflected separately in VideoCount and LiveStreamCount; preview thumbnails only reflect the videos in each collection. When includeThumbnails is true, preview thumbnails are only populated for the first 60 collections of the returned page — later items in a larger page are returned without thumbnails.

get/library/{libraryId}/collections

Request

Path parameters

libraryIdinteger required

The ID of the video library.

Query parameters

pageinteger

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

itemsPerPageinteger

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

searchstring nullable

Filters collections by name, case-insensitive substring match.

orderBystring nullable

The field to order results by. Possible values: date, title — any other value falls back to date.

includeThumbnailsboolean

If set to true, populates PreviewImageUrls for each collection (only for the first 60 collections of the page).

Response

The list of videos for the current parameters

totalItemsinteger

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

currentPageinteger

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

itemsPerPageinteger

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

Changes

  • 83116184952fRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the optional property // to the response with the status