Box Developerドキュメント
 
    最新バージョン

    すべてのコレクションのリストを取得

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

    このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

    指定したユーザーのすべてのコレクションを取得します。

    現在サポートされているのは、favoritesコレクションのみです。

    リクエスト

    bearer [ACCESS_TOKEN]
    application/json

    クエリパラメータ

    string arrayクエリ内省略可能
    id,type,name

    レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。

    このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。

    integer (int64)クエリ内省略可能
    1000
    1000

    返す項目の1ページあたりの最大数。

    integer (int64)クエリ内省略可能
    1000
    0

    レスポンスが開始される項目のオフセット。

    オフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。

    レスポンス

    application/jsonCollections

    指定したユーザーのすべてのコレクションを返します

    予期しないクライアントエラー。

    get
    すべてのコレクションのリストを取得
    このドキュメント内で一部のAPIを試せるようになりました。
    ログイン

    リクエストの例

    cURL
    curl -i -X GET "https://api.box.com/2.0/collections" \
         -H "authorization: Bearer <ACCESS_TOKEN>"

    レスポンスの例

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