Bynder Collections API

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