Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Latest version

Get collection by ID

get
https://api.box.com/2.0
/collections/:collection_id

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Retrieves a collection by its ID.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
926489

The ID of the collection.

Response

application/jsonCollection

Returns an array of items in the collection.

application/jsonClient error

An unexpected client error.

get
Get collection by ID
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


Node/TypeScript v10
await client.collections.getCollectionById(collections.entries![0].id!);
Python v10
client.collections.get_collection_by_id(collections.entries[0].id)
.NET v10
await client.Collections.GetCollectionByIdAsync(collectionId: NullableUtils.Unwrap(NullableUtils.Unwrap(collections.Entries)[0].Id));
Swift v10
try await client.collections.getCollectionById(collectionId: collections.entries![0].id!)

Response Example

{
  "id": "11446498",
  "type": "collection",
  "collection_type": "favorites",
  "name": "Favorites"
}