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

アーカイブのリストを取得

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

企業用のアーカイブを取得します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエストヘッダー

stringヘッダー内必須

Version header.

次の値に固定: 2025.0

クエリパラメータ

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

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

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。

レスポンス

application/jsonArchives

企業内のアーカイブのリストを返します。

パラメータが不足しているか無効の場合はエラーを返します。

Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。

認証済みユーザーにアーカイブのリストを取得するための適切な権限がない場合にエラーを返します。

予期しないサーバーエラー。

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

get
アーカイブのリストを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/archives" \
     -H "box-version: 2025.0" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.archives.getArchivesV2025R0({
  limit: 100,
} satisfies GetArchivesV2025R0QueryParams);
Python Gen
client.archives.get_archives_v2025_r0(limit=100)
.NET Gen
await client.Archives.GetArchivesV2025R0Async(queryParams: new GetArchivesV2025R0QueryParams() { Limit = 100 });

レスポンスの例

{
  "entries": [
    {
      "id": "12345",
      "name": "Archive",
      "size": 123456789,
      "type": "archive"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}