Get Collection List

GET /library/{libraryId}/collections

Get Collection List

cURL

curl --request GET \
  --url https://video.bunnycdn.com/library/{libraryId}/collections \
  --header 'AccessKey: <api-key>'

import requests

url = "https://video.bunnycdn.com/library/{libraryId}/collections"

headers = {"AccessKey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {AccessKey: '<api-key>'}};

fetch('https://video.bunnycdn.com/library/{libraryId}/collections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://video.bunnycdn.com/library/{libraryId}/collections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "AccessKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://video.bunnycdn.com/library/{libraryId}/collections"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("AccessKey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://video.bunnycdn.com/library/{libraryId}/collections")
  .header("AccessKey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://video.bunnycdn.com/library/{libraryId}/collections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["AccessKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "totalItems": 123,
  "currentPage": 123,
  "itemsPerPage": 123,
  "items": [
    {
      "videoLibraryId": 123,
      "guid": "<string>",
      "name": "<string>",
      "videoCount": 123,
      "totalSize": 123,
      "previewVideoIds": "<string>",
      "previewImageUrls": [
        "<string>"
      ]
    }
  ]
}

Authorizations

AccessKey · string · header · required

AccessKey based authentication

Path Parameters

libraryId · integer<int64> · required

Query Parameters

page · integer<int32> · default: 1

itemsPerPage · integer<int32> · default: 100

search · string | null · default: ""

orderBy · string | null · default: date

includeThumbnails · boolean · default: false

Response

200

application/json

The list of videos for the current parameters

totalItems · integer<int64>

The total number of items that can be returned

currentPage · integer<int64>

The current page of the response

itemsPerPage · integer<int32>

The number of items returned per page

items · object[] | null

The result items on the current result

Show child attributes