List User's Collections

GuidesCollectionsList User's Collections
Edit this page

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>"
.NET
BoxCollection<BoxCollectionItem> collections = await client.CollectionsManager.GetCollectionsAsync();
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('Collection "{0}" has ID {1}'.format(collection.name, collection.id))
Node
client.collections.getAll()
	.then(collections => {
		/* collections -> { total_count: 1,
			entries: 
			[ { type: 'collection',
				id: '11111',
				name: 'Favorites',
				collection_type: 'favorites' } ],
			limit: 100,
			offset: 0 }
		*/
	});

The only collection that is available via the API is the "Favorites" collection. The ID of this collection is different for every user.

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
}