api

Collecties ophalen

GET https://api.mave.io/v1/collections

Hiermee haal je de collecties direct in één folder op, gesorteerd op aanmaakdatum (nieuwste eerst). Zonder collection krijg je alleen collecties in de root van de space. De lijst is niet recursief en is gepagineerd met standaard 15 items per pagina. Hiervoor is het API-token vereist.

De video_count van een collectie telt video’s in geneste collecties wel mee. Die waarde kan dus hoger zijn dan het aantal video’s direct in de collectie.

Queryparameters

Parameter	Type
page	positief geheel getal (standaard: 1)
per_page	positief geheel getal (standaard: 15, max. 100)
collection	collectie-ID; toont alleen directe subcollecties. Laat weg of gebruik een lege waarde voor de root van de space.
archived	boolean; `true` toont gearchiveerde collecties. Zonder deze parameter of bij `false` worden actieve collecties getoond.

Response

{
  "current_page": 1, // the page you are looking at
  "data": [
    {
      "created": 1683272297,
      "id": "zlb1cnE31EQetyx",
      "name": "test", // name of the collection
      "object": "collection", // type of the object
      "video_count": 3 // the amount of videos in this collection
    },
    {
      "created": 1683190633,
      "id": "zlb1cAvWg15i9NW",
      "name": "Collection",
      "object": "collection",
      "video_count": 0
    }
  ], // all the collections that have been created
  "has_more": false, // the possibility whether there are more video embeds to retrieve
  "object": "list", // the type of object you're looking at
  "total_items": 2, // the total of video embeds
  "total_pages": 1 // the total pages that are available
}