BObox
Collections

Get collection by ID

Changed on

Retrieves a collection by its ID.

get/collections/{collection_id}

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/collections/{collection_id}
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Path parameters

collection_idstring required

The ID of the collection.

Response

Returns an array of items in the collection.

idstring

The unique identifier for this collection.

type'collection'

The value will always be collection.

name'Favorites'

The name of the collection.

collection_type'favorites'

The type of the collection. This is used to determine the proper visual treatment for collections.

Example response

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

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status