メインコンテンツへスキップ
GET
/
folders
/
{folder_id}
/
items
cURL
curl -i -X GET "https://api.box.com/2.0/folders/0/items" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "total_count": 5000,
  "offset": 2000,
  "order": [
    {
      "by": "type",
      "direction": "ASC"
    }
  ],
  "entries": [
    {
      "id": "12345",
      "type": "file",
      "etag": "1",
      "sequence_id": "3",
      "name": "Contract.pdf",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "file_version": {
        "id": "12345",
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      },
      "description": "Contract for Q1 renewal",
      "size": 629644,
      "path_collection": {
        "total_count": 1,
        "entries": [
          {
            "id": "12345",
            "type": "folder",
            "etag": "1",
            "sequence_id": "3",
            "name": "Contracts"
          }
        ]
      },
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "trashed_at": "2012-12-12T10:53:43-08:00",
      "purged_at": "2012-12-12T10:53:43-08:00",
      "content_created_at": "2012-12-12T10:53:43-08:00",
      "content_modified_at": "2012-12-12T10:53:43-08:00",
      "created_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "modified_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "owned_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "shared_link": {
        "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
        "effective_access": "company",
        "effective_permission": "can_download",
        "is_password_enabled": true,
        "download_count": 3,
        "preview_count": 3,
        "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
        "vanity_url": "https://acme.app.box.com/v/my_url/",
        "vanity_name": "my_url",
        "access": "open",
        "unshared_at": "2018-04-13T13:53:23-07:00",
        "permissions": {
          "can_download": true,
          "can_preview": true,
          "can_edit": false
        }
      },
      "parent": {
        "id": "12345",
        "type": "folder",
        "etag": "1",
        "sequence_id": "3",
        "name": "Contracts"
      },
      "item_status": "active",
      "version_number": "1",
      "comment_count": 10,
      "permissions": {
        "can_delete": true,
        "can_download": true,
        "can_invite_collaborator": true,
        "can_rename": true,
        "can_set_share_access": true,
        "can_share": true,
        "can_annotate": true,
        "can_comment": true,
        "can_preview": true,
        "can_upload": true,
        "can_view_annotations_all": true,
        "can_view_annotations_self": true,
        "can_apply_watermark": true
      },
      "tags": [
        "approved"
      ],
      "lock": {
        "id": "11446498",
        "type": "lock",
        "created_by": {
          "id": "11446498",
          "type": "user",
          "name": "Aaron Levie",
          "login": "ceo@example.com"
        },
        "created_at": "2012-12-12T10:53:43-08:00",
        "expired_at": "2012-12-12T10:53:43-08:00",
        "is_download_prevented": true,
        "app_type": "office_wopiplus"
      },
      "extension": "pdf",
      "is_package": true,
      "expiring_embed_link": {
        "access_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
        "expires_in": 3600,
        "token_type": "bearer",
        "restricted_to": [
          {
            "scope": "item_download",
            "object": {
              "id": "12345",
              "type": "folder",
              "etag": "1",
              "sequence_id": "3",
              "name": "Contracts"
            }
          }
        ],
        "url": "https://cloud.app.box.com/preview/expiring_embed/..."
      },
      "watermark_info": {
        "is_watermarked": true,
        "is_watermark_inherited": false,
        "is_watermarked_by_access_policy": false
      },
      "is_accessible_via_shared_link": true,
      "allowed_invitee_roles": [
        "editor"
      ],
      "is_externally_owned": true,
      "has_collaborations": true,
      "metadata": {
        "enterprise_27335": {
          "marketingCollateral": {
            "$canEdit": true,
            "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
            "$parent": "folder_59449484661",
            "$scope": "enterprise_27335",
            "$template": "marketingCollateral",
            "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
            "$typeVersion": 2,
            "$version": 1
          }
        }
      },
      "expires_at": "2012-12-12T10:53:43-08:00",
      "representations": {
        "entries": [
          {
            "content": {
              "url_template": "https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567"
            },
            "info": {
              "url": "https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048"
            },
            "properties": {
              "dimensions": "2048x2048",
              "paged": "true",
              "thumb": "true"
            },
            "representation": "png",
            "status": {
              "state": "success"
            }
          }
        ]
      },
      "classification": {
        "name": "Top Secret",
        "definition": "Content that should not be shared outside the company.",
        "color": "#FF0000"
      },
      "uploader_display_name": "Ellis Wiggins",
      "disposition_at": "2012-12-12T10:53:43-08:00",
      "shared_link_permission_options": [
        "can_preview"
      ],
      "is_associated_with_app_item": true
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

​
Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

ヘッダー

​
boxapi
string

この項目の共有リンクのURLと省略可能なパスワード。

このヘッダーを使用すると、ユーザーと明示的に共有されていない項目にアクセスできます。

shared_link=[link]形式を使用するか、パスワードが必要な場合はshared_link=[link]&shared_link_password=[password]を使用します。

このヘッダーは、共有されているファイルまたはフォルダのほか、その項目内にネストされているすべてのファイルやフォルダで使用できます。

パスパラメータ

​
folder_id
string
必須

フォルダを表す一意の識別子。

フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123の場合、folder_idは123です。

Boxアカウントのルートフォルダは常にID 0で表されます。

クエリパラメータ

​
fields
string[]

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

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

また、このフィールドを使用すると、ファイルに適用されている任意のメタデータに対してクエリを実行できます。その際、metadataフィールドのほか、取得するテンプレートのスコープとキー (例: ?fields=metadata.enterprise_12345.contractTemplate) も指定します。

​
usemarker
boolean

オフセットベースのページネーション方式ではなくマーカーベースのページネーション方式を使用するかどうかを指定します。同時に使用できるページネーション方式は1つのみです。

この値をtrueに設定すると、APIは、レスポンスの次のページを取得するために、このエンドポイントにパラメータとして渡すことができるmarkerフィールドを返します。

​
marker
string

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

これを使用するには、usemarkerをtrueに設定する必要があります。

​
offset
integer<int64>
デフォルト:0

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

オフセットベースのページネーションは、オフセット値が高い場合に確実に動作するとは限らず、データセットが大きい場合は失敗する可能性があります。このような場合は、usemarkerをtrueに設定して、マーカーベースのページネーションを使用してください。

​
limit
integer<int64>

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

必須範囲: x <= 1000
​
sort
enum<string>

項目並べ替えの2番目の基準として使用される属性を定義します。

フォルダの種類は、項目の並べ替え方法に影響します。

  • 標準フォルダ: 項目は必ず最初にtypeを基準にして並べ替えられ、フォルダはファイルよりも前に、ファイルはウェブリンクよりも前にリストされます。

  • ルートフォルダ: ルートフォルダ

    (idが0のフォルダ) の場合、マーカーベースのページネーションでこのパラメータはサポートされません。

  • 関連付けられたフォルダの親パスがコラボレータに表示される共有フォルダ: 項目は必ず最初にtypeを基準にして並べ替えられ、フォルダはファイルよりも前に、ファイルはウェブリンクよりも前にリストされます。

利用可能なオプション:
id,
name,
date,
size
​
direction
enum<string>

結果を並べ替える方向。アルファベットの昇順 (ASC) または降順 (DESC) のいずれかを指定できます。

利用可能なオプション:
ASC,
DESC

レスポンス

フォルダに含まれるファイル、フォルダ、およびウェブリンクのコレクションを返します。

Mini版の表示に含まれるファイル、フォルダ、ウェブリンクのリスト。

​
limit
integer<int64>

これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。

例:

1000

​
next_marker
string | null

次の検索結果ページの開始場所のマーカー。

例:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"

​
prev_marker
string | null

前の検索結果ページの開始場所のマーカー。

例:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"

​
total_count
integer<int64>

コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、total_countよりも少ない場合があります。

このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。

例:

5000

​
offset
integer<int64>

このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、offsetクエリパラメータと同じになります。

このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。

例:

2000

​
order
object[]

項目が返される順序。

このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。

​
entries
(ファイル (Full) · object | フォルダ (Mini) · object | ウェブリンク · object)[]

このコレクション内の項目。

任意のファイルAPIエンドポイントからデフォルトで返される可能性があるファイルのFull版の表示。