---
title: "Collections API"
url: "https://earlyaccess.developers.bynder.com/apis/collections-api-1/versions/fa75179f-d3db-46c2-8693-3128e9d35db4"
---

# Collections API

OpenAPI specification document.

```json
{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"COLLECTIONS":"","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":"","collection.public.view":"To retrieve public collections"},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"COLLECTIONS":"","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":"","collection.public.view":"To retrieve public collections"},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Collections API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/v4/collections":{"get":{"description":"Retrieve a list of collections.","parameters":[{"in":"query","name":"limit","schema":{"default":50,"maximum":1000,"type":"integer"}},{"in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"in":"query","name":"orderBy","schema":{"enum":["dateCreated asc","dateCreated desc","name asc","name desc"],"type":"string"}},{"in":"query","name":"ids","schema":{"example":"00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000","type":"string"}},{"in":"query","name":"count","schema":{"default":false,"type":"boolean"}},{"in":"query","name":"keyword","schema":{"example":"Amsterdam","type":"string"}},{"in":"query","name":"isPublic","schema":{"default":false,"type":"boolean"}},{"in":"query","name":"minCount","schema":{"default":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"example1":{"value":[{"collectionCount":2,"cover":{"large":"___URL_TO_BYNDER_CDN___","thumbnail":"___URL_TO_BYNDER_CDN___","thumbnails":["___URL_TO_BYNDER_CDN___","___URL_TO_BYNDER_CDN___","___URL_TO_BYNDER_CDN___"]},"dateCreated":"March, 01 2017 10:49:12 +0000","dateModified":"March, 08 2017 14:17:37 +0000","description":"Collection 1 with various assets.","filename":"collection_1","id":"00B627BB-8054-44C0-A343FCF40BC790CD","isPublic":true,"name":"Collection 1","user":{"id":"48817BA7-2FC3-4A43-918761514D322C15","name":"John Doe"},"userId":"48817BA7-2FC3-4A43-918761514D322C15"},{"collectionCount":4,"cover":{"large":"___URL_TO_BYNDER_CDN___","thumbnail":"___URL_TO_BYNDER_CDN___","thumbnails":["___URL_TO_BYNDER_CDN___","___URL_TO_BYNDER_CDN___","___URL_TO_BYNDER_CDN___"]},"dateCreated":"October, 30 2014 13:54:00 +0000","dateModified":"March, 10 2017 07:57:18 +0000","description":"Collection 2 with various assets.","filename":"collection_2","id":"050960F7-98B3-461D-B967F4B84D3A3866","isPublic":false,"name":"Collection 2","user":{"id":"80E53210-5BB0-4BF9-907F917D457801BB","name":"Jane Doe"},"userId":"80E53210-5BB0-4BF9-907F917D457801BB"}]}},"schema":{"items":{"properties":{"collectionCount":{"example":2,"type":"integer"},"cover":{"properties":{"large":{"example":"___URL_TO_BYNDER_CDN___","type":"string"},"thumbnail":{"example":"___URL_TO_BYNDER_CDN___","type":"string"},"thumbnails":{"items":{"example":"___URL_TO_BYNDER_CDN___","type":"string"},"type":"array"}},"type":"object"},"dateCreated":{"example":"March, 01 2017 10:49:12 +0000","type":"string"},"dateModified":{"example":"March, 08 2017 14:17:37 +0000","type":"string"},"description":{"example":"Collection 1 with various assets.","type":"string"},"filename":{"example":"collection_1","type":"string"},"id":{"example":"00B627BB-8054-44C0-A343FCF40BC790CD","type":"string"},"isPublic":{"example":true,"type":"boolean"},"name":{"example":"Collection 1","type":"string"},"user":{"properties":{"id":{"example":"48817BA7-2FC3-4A43-918761514D322C15","type":"string"},"name":{"example":"John Doe","type":"string"}},"type":"object"},"userId":{"example":"48817BA7-2FC3-4A43-918761514D322C15","type":"string"}},"type":"object"},"type":"array"}}},"description":"A list of collections."},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Invalid request parameters.","type":"string"},"statuscode":{"example":400,"type":"integer"}},"type":"object"}}},"description":"Invalid request parameters."}},"security":[{"OAuth2":["collection.public.view","INBOXPUBLIC","OUTBOXPUBLIC","PUBLICCOLLECTIONS"]},{"permanentToken":["collection.public.view","INBOXPUBLIC","OUTBOXPUBLIC","PUBLICCOLLECTIONS"]}],"summary":"Retrieve collections","tags":["Collections"]},"post":{"description":"Create a new collection.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"description":{"description":"Collection description","example":"Collection of featured assets","type":"string"},"name":{"description":"Collection name","example":"Featured collection","type":"string"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Created","type":"string"},"statuscode":{"example":201,"type":"integer"}},"type":"object"}}},"description":"Created","headers":{"Location":{"description":"URL to the created collection","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Collection name can't be empty","type":"string"},"statuscode":{"example":400,"type":"integer"}},"type":"object"}}},"description":"Bad Request"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Access denied","type":"string"},"statuscode":{"example":403,"type":"integer"}},"type":"object"}}},"description":"Access denied"}},"security":[{"OAuth2":["COLLECTIONS"]},{"permanentToken":["COLLECTIONS"]}],"summary":"Create collection","tags":["Collections"]}},"/api/v4/collections/{id}":{"delete":{"description":"Delete a specific collection by ID.","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Collection not found","type":"string"},"statuscode":{"example":404,"type":"integer"}},"type":"object"}}},"description":"Collection not found."}},"security":[{"OAuth2":[]},{"permanentToken":[]}],"summary":"Delete collection","tags":["Collections ID"]},"get":{"description":"Retrieve a specific collection by ID.","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"example1":{"value":{"dateCreated":"March, 01 2017 10:49:12 +0000","description":"Collection 1 with various assets.","link":"___URL_TO_BYNDER_CDN___","name":"Collection 1","thumbnail":"___URL_TO_BYNDER_CDN___","user":{"id":"80E53210-5BB0-4BF9-907F917D457801BB","name":"Jane Doe"},"views":2}}},"schema":{"properties":{"dateCreated":{"example":"March, 01 2017 10:49:12 +0000","type":"string"},"description":{"example":"Collection 1 with various assets.","type":"string"},"link":{"example":"___URL_TO_BYNDER_CDN___","type":"string"},"name":{"example":"Collection 1","type":"string"},"thumbnail":{"example":"___URL_TO_BYNDER_CDN___","type":"string"},"user":{"properties":{"id":{"example":"80E53210-5BB0-4BF9-907F917D457801BB","type":"string"},"name":{"example":"Jane Doe","type":"string"}},"type":"object"},"views":{"example":2,"type":"integer"}},"type":"object"}}},"description":"A specific collection."},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Collection not found","type":"string"},"statuscode":{"example":404,"type":"integer"}},"type":"object"}}},"description":"Collection not found."}},"security":[{"OAuth2":[]},{"permanentToken":[]}],"summary":"Retrieve specific collection","tags":["Collections ID"]},"post":{"description":"Modify a specific collection by ID.","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"description":{"example":"Collection of featured assets","type":"string"},"isPublic":{"example":true,"type":"boolean"},"name":{"example":"Featured collection","type":"string"},"thumbnailAssetId":{"example":"00000000-0000-0000-0000000000000000","type":"string"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Created","type":"string"},"statuscode":{"example":201,"type":"integer"}},"type":"object"}}},"description":"Collection modified."},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Collection name can't be empty","type":"string"},"statuscode":{"example":400,"type":"integer"}},"type":"object"}}},"description":"Invalid request parameters."},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Access denied","type":"string"},"statuscode":{"example":403,"type":"integer"}},"type":"object"}}},"description":"Access denied."}},"security":[{"OAuth2":["COLLECTIONS","PUBLISHCOLLECTIONS"]},{"permanentToken":["COLLECTIONS","PUBLISHCOLLECTIONS"]}],"summary":"Modify collection","tags":["Collections ID"]}},"/api/v4/collections/{id}/media":{"delete":{"description":"Remove assets from a specific collection by ID.","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}},{"in":"query","name":"deleteIds","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000","type":"string"}}],"responses":{"204":{"description":"No Content"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Access denied","type":"string"},"statuscode":{"example":403,"type":"integer"}},"type":"object"}}},"description":"Access denied."}},"security":[{"OAuth2":["COLLECTIONS"]},{"permanentToken":["COLLECTIONS"]}],"summary":"Remove assets from a collection","tags":["Collections assets"]},"get":{"description":"Retrieve the assets of a specific collection by ID.","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"example1":{"value":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000001","00000000-0000-0000-0000000000000002"]}},"schema":{"items":{"example":"00000000-0000-0000-0000000000000000","type":"string"},"type":"array"}}},"description":"A list of asset IDs."},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Collection not found","type":"string"},"statuscode":{"example":404,"type":"integer"}},"type":"object"}}},"description":"Collection not found."}},"security":[{"OAuth2":[]},{"permanentToken":[]}],"summary":"Retrieve the assets of a specific collection","tags":["Collections assets"]},"post":{"description":"Add assets to a specific collection by ID.","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"data":{"example":"[\"00000000-0000-0000-0000000000000000\"]","type":"string"}},"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Accepted","type":"string"},"statuscode":{"example":202,"type":"integer"}},"type":"object"}}},"description":"Assets added to collection."},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Access denied","type":"string"},"statuscode":{"example":403,"type":"integer"}},"type":"object"}}},"description":"Access denied."}},"security":[{"OAuth2":["COLLECTIONS"]},{"permanentToken":["COLLECTIONS"]}],"summary":"Add assets to a collection","tags":["Collections assets"]}},"/api/v4/collections/{id}/share":{"post":{"description":"Share a specific collection by ID.","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"collectionOptions":{"enum":["readOnly","view","readAccess","edit"],"example":"view","type":"string"},"dateEnd":{"example":"2015-08-12T08:07:24Z","type":"string"},"dateStart":{"example":"2014-08-12T08:07:24Z","type":"string"},"groups":{"example":"00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000","type":"string"},"loginRequired":{"example":true,"type":"boolean"},"message":{"example":"Your message goes here","type":"string"},"profiles":{"example":"00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000","type":"string"},"recipients":{"example":"user1@bynder.com,user2@bynder.com","type":"string"},"sendMail":{"example":true,"type":"boolean"}},"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"accepted","type":"string"},"statuscode":{"example":202,"type":"integer"}},"type":"object"}}},"description":"Collection shared."},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Recipients, groups or profiles must contain at least one entry","type":"string"},"statuscode":{"example":400,"type":"integer"}},"type":"object"}}},"description":"Invalid request parameters."}},"security":[{"OAuth2":["SHARECOLLECTION","SHARING"]},{"permanentToken":["SHARECOLLETION","SHARING"]}],"summary":"Share collection","tags":["Share collection"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"","name":"Collections"},{"description":"","name":"Collections ID"},{"description":"","name":"Share collection"},{"description":"","name":"Collections assets"}]}
```