Box Developerドキュメント

Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。

ユーザーのコレクションのリストの取得

ガイド コレクション ユーザーのコレクションのリストの取得

ユーザーのコレクションのリストの取得

ユーザーのすべてのコレクションのリストを取得するには、GET /collections APIを呼び出します。

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()
.NET v6
await client.Collections.GetCollectionsAsync();
Node v4
await client.collections.getCollections();

APIを介して使用できるコレクションは「お気に入り」コレクションのみです。このコレクションのIDはユーザーごとに異なります。

お気に入りコレクション

現在APIを介して項目を追加および削除できるコレクションは「お気に入り」コレクションのみです。

お気に入りコレクションのIDはユーザーごとに異なります。ユーザーのお気に入りのコレクションIDを確認するには、ユーザーの全コレクションのリストを取得し、collection_typefavoritesのコレクションを探します。

{
  "entries": [
    {
      "collection_type": "favorites",
      "id": "12345678",
      "name": "Favorites",
      "type": "collection"
    }
  ],
  "limit": 100,
  "offset": 0,
  "total_count": 1
}