List User's Collections
List User's Collections
To list all collections for a user, call the GET /collections API.
cURL
curl -i -X GET "https://api.box.com/2.0/collections" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.collections.getCollections();Python Gen
client.collections.get_collections().NET Gen
await client.Collections.GetCollectionsAsync();Swift Gen (Beta)
try await client.collections.getCollections()Java
Iterable<BoxCollection.Info> collections = BoxCollection.getAllCollections(api);
for (BoxCollection.Info collectionInfo : collections) {
// Do something with the collection.
}Python
collections = client.collections()
for collection in collections:
print(f'Collection "{collection.name}" has ID {collection.id}').NET
BoxCollection<BoxCollectionItem> collections = await client.CollectionsManager.GetCollectionsAsync();Node
client.collections.getAll()
.then(collections => {
/* collections -> { total_count: 1,
entries:
[ { type: 'collection',
id: '11111',
name: 'Favorites',
collection_type: 'favorites' } ],
limit: 100,
offset: 0 }
*/
});Favorites Collection
The only collection that can items can currently be added and removed to via the API is the "Favorites" collection.
The ID of the favorites collection is different for every user. To find the
user's collection ID for their favorites, list all the user's collections and
then find the collection with a collection_type of favorites.
{
"entries": [
{
"collection_type": "favorites",
"id": "12345678",
"name": "Favorites",
"type": "collection"
}
],
"limit": 100,
"offset": 0,
"total_count": 1
}