最新バージョン
すべてのコレクションのリストを取得
APIバージョン 2024.0
指定したユーザーのすべてのコレクションを取得します。
現在サポートされているのは、favoritesコレクションのみです。
リクエスト
bearer [ACCESS_TOKEN]
application/json
クエリパラメータ
string arrayクエリ内省略可能
id,type,nameレスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
integer (int64)クエリ内省略可能
10001000返す項目の1ページあたりの最大数。
integer (int64)クエリ内省略可能
10000レスポンスが開始される項目のオフセット。
オフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。
レスポンス
application/jsonCollections
指定したユーザーのすべてのコレクションを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X GET "https://api.box.com/2.0/collections" \
-H "authorization: Bearer <ACCESS_TOKEN>"Node/TypeScript v10
await client.collections.getCollections();Python v10
client.collections.get_collections().NET v10
await client.Collections.GetCollectionsAsync();Swift v10
try await client.collections.getCollections()Java v5
Iterable<BoxCollection.Info> collections = BoxCollection.getAllCollections(api);
for (BoxCollection.Info collectionInfo : collections) {
// Do something with the collection.
}Python v4
collections = client.collections()
for collection in collections:
print(f'Collection "{collection.name}" has ID {collection.id}').NET v6
BoxCollection<BoxCollectionItem> collections = await client.CollectionsManager.GetCollectionsAsync();Node v4
client.collections.getAll()
.then(collections => {
/* collections -> { total_count: 1,
entries:
[ { type: 'collection',
id: '11111',
name: 'Favorites',
collection_type: 'favorites' } ],
limit: 100,
offset: 0 }
*/
});レスポンスの例
{
"entries": [
{
"collection_type": "favorites",
"id": "11446498",
"name": "Favorites",
"type": "collection"
}
],
"limit": 1000,
"offset": 2000,
"order": [
{
"by": "type",
"direction": "ASC"
}
],
"total_count": 5000
}