Join BoxWorks 2024 to discover what's possible with content and AI!

List all collections

get

https://api.box.com/2.0

/collections

Retrieves all collections for a given user.

Currently, only the favorites collection is supported.

Related Guides

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Query Parameters

fields string arrayin queryoptional

exampleid,type,name

A 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.

limit integer (int64)in queryoptional

example1000max1000

The maximum number of items to return per page.

offset integer (int64)in queryoptional

example1000default0

The 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

200application/jsonCollections

Returns all collections for the given user

defaultapplication/jsonClient error

An unexpected client error.

get

List all collections

You can now try out some of our APIs live, right here in the documentation.

Request Example

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 }
		*/
	});

Response Example

{
  "entries": [
    {
      "id": "11446498",
      "type": "collection",
      "name": "Favorites",
      "collection_type": "favorites"
    }
  ],
  "limit": 1000,
  "offset": 2000,
  "order": [
    {
      "by": "type",
      "direction": "ASC"
    }
  ],
  "total_count": 5000
}