List all collections
Retrieves all collections for a given user.
Currently, only the favorites collection
is supported.
Request
Query Parameters
id,type,nameA comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
10001000The maximum number of items to return per page.
10000The offset of the item at which to begin the response.
Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
Response
Returns all collections for the given user.
An unexpected client error.
Request Example
curl -i -X GET "https://api.box.com/2.0/collections" \
-H "authorization: Bearer <ACCESS_TOKEN>"await client.collections.getCollections();client.collections.get_collections()await client.Collections.GetCollectionsAsync();try await client.collections.getCollections()Iterable<BoxCollection.Info> collections = BoxCollection.getAllCollections(api);
for (BoxCollection.Info collectionInfo : collections) {
// Do something with the collection.
}collections = client.collections()
for collection in collections:
print(f'Collection "{collection.name}" has ID {collection.id}')BoxCollection<BoxCollectionItem> collections = await client.CollectionsManager.GetCollectionsAsync();client.collections.getAll()
.then(collections => {
/* collections -> { total_count: 1,
entries:
[ { type: 'collection',
id: '11111',
name: 'Favorites',
collection_type: 'favorites' } ],
limit: 100,
offset: 0 }
*/
});Response Example
{
"entries": [
{
"collection_type": "favorites",
"id": "11446498",
"name": "Favorites",
"type": "collection"
}
],
"limit": 1000,
"offset": 2000,
"order": [
{
"by": "type",
"direction": "ASC"
}
],
"total_count": 5000
}