メインコンテンツへスキップ
GET
/
search
cURL
curl -i -X GET "https://api.box.com/2.0/search?query=sales" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "type": "search_results_items",
  "total_count": 5000,
  "limit": 1000,
  "offset": 2000,
  "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": "[email protected]"
      },
      "modified_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "[email protected]"
      },
      "owned_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "[email protected]"
      },
      "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
      },
      "tags": [
        "approved"
      ],
      "lock": {
        "id": "11446498",
        "type": "lock",
        "created_by": {
          "id": "11446498",
          "type": "user",
          "name": "Aaron Levie",
          "login": "[email protected]"
        },
        "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_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
    }
  ]
}
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

認証

​
Authorization
string
header
必須

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

クエリパラメータ

​
query
string

検索する文字列。このクエリは、項目名、説明、ファイルのテキストコンテンツなど、さまざまな項目タイプのフィールドと照合されます。

このパラメータでは、返された結果をさらに絞り込むためのさまざまな演算子がサポートされます。

  • "" - クエリを二重引用符で囲むと、APIによって完全一致のみが返されます。完全一致検索では、特定の文字の並びに基づいた検索結果は返されません。代わりに、フレーズ (つまり、単語の並び) に基づいた一致が返されます。たとえば、"Blue-Box"を検索すると、"blue.box"、"Blue Box"、"Blue-Box"などの並びを含む、検索結果が返されます。つまり、BlueおよびBoxという単語が指定した順序で連続して含まれている項目です。
  • AND - 両方の検索語句を含む項目が返されます。たとえば、marketing AND BoxWorksを検索すると、marketingとBoxWorksの両方が任意の順番でテキストに含まれている項目が返されます。テキストにBoxWorksのみが含まれる結果は返されません。
  • OR - 検索語句のいずれかを含む項目が返されます。たとえば、marketing OR BoxWorksを検索すると、marketingとBoxWorksのいずれかがテキストに含まれている結果が返されます。サポートされている別のブール条件が使用されている場合を除き、複数語のクエリは暗黙的にORとして解釈されるため、この演算子の使用は必須ではありません。
  • NOT - 指定された検索語句が含まれていない項目が返されます。たとえば、marketing AND NOT BoxWorksを検索すると、テキストにmarketingのみが含まれている結果が返され、BoxWorksが含まれる結果は省略されます。

小文字の演算子 (and、orおよびnot) および大文字と小文字を組み合わせた演算子 (And、OrおよびNot) はサポートされていません。

このフィールドは、mdfiltersパラメータが定義されていない場合に必須です。

​
scope
enum<string>
デフォルト:user_content

ユーザーがアクセスできるファイルまたは会社全体で利用可能なファイルに検索結果を絞り込みます。

スコープは、デフォルトでuser_contentに設定されます。これにより、検索結果は、現在認証されているユーザーが使用できるコンテンツに絞り込まれます。

enterprise_contentは、管理者がサポートチャネルを通じてリクエストできます。このスコープがユーザーに対して有効になっていると、そのユーザーは、アクセスできるコンテンツだけでなく、会社全体のコンテンツに対してクエリを実行できます。

利用可能なオプション:
user_content,
enterprise_content
​
file_extensions
string[]

指定したファイル拡張子のいずれかと一致するファイルのみに検索結果を絞り込みます。このリストは、ドットなしのファイル拡張子のコンマ区切りリストです。

​
created_at_range
string[]

指定した日付範囲内に作成されたすべての項目に検索結果を絞り込みます。

日付範囲はコンマ区切りのRFC3339タイムスタンプとして定義されます。

開始日が省略されている場合 (,2014-05-17T13:35:01-07:00)、終了日より前に作成された項目がすべて返されます。

終了日が省略されている場合 (2014-05-15T13:35:01-07:00,)、代わりに現在の日付が終了日として使用されます。

​
updated_at_range
string[]

指定した日付範囲内に更新された項目に検索結果を絞り込みます。

日付範囲はコンマ区切りのRFC3339タイムスタンプとして定義されます。

開始日が省略されている場合 (,2014-05-17T13:35:01-07:00)、終了日より前に更新された項目が返されます。

終了日が省略されている場合 (2014-05-15T13:35:01-07:00,)、代わりに現在の日付が終了日として使用されます。

​
size_range
integer[]

特定のファイルサイズ範囲内のサイズの項目に検索結果を絞り込みます。これはファイルとフォルダに適用されます。

サイズ範囲は、バイトサイズの下限と上限 (下限と上限も含む) のコンマ区切りリストとして定義します。

上限または下限を省略すると、上限または下限のないサイズ範囲を指定できます。

​
owner_user_ids
string[]

指定した所有者リスト (ユーザーIDのコンマ区切りリストとして定義) によって所有される項目のみに検索結果を絞り込みます。

検索結果に項目が表示されるように、項目は現在認証されているユーザーによって所有または共有されている必要もあります。いずれかのユーザーが所有するファイルにユーザーがアクセスできない場合は、空の結果セットが返されます。

会社全体で検索するには、サポートチームにリクエスト可能なenterprise_contentスコープパラメータを使用することをお勧めします。

​
recent_updater_user_ids
string[]

指定したユーザーリスト (ユーザーIDのコンマ区切りリストとして定義) によって更新された項目のみに検索結果を絞り込みます。

検索結果に項目が表示されるように、項目は現在認証されているユーザーによって所有または共有されている必要もあります。いずれかのユーザーが所有するファイルにユーザーがアクセスできない場合は、空の結果セットが返されます。

この機能では、項目の過去10バージョンのみを検索します。

​
ancestor_folder_ids
string[]

フォルダIDのコンマ区切りリストとして定義された、指定したフォルダリスト内の項目のみに検索結果を絞り込みます。

検索結果には、これらの先祖フォルダのサブフォルダ内の項目も含まれます。

フォルダは現在認証されているユーザーによって所有または共有されている必要もあります。このユーザーがフォルダにアクセスできない場合、またはフォルダがない場合は、代わりにHTTP 404エラーコードが返されます。

会社全体で検索するには、サポートチームにリクエスト可能なenterprise_contentスコープパラメータを使用することをお勧めします。

​
content_types
enum<string>[]

ファイルの説明など、ファイルの特定の部分に対する検索クエリと一致する項目のみに検索結果を絞り込みます。

コンテンツタイプの定義には、Boxで認識されるコンテンツタイプのコンマ区切りリストを使用します。許可されるコンテンツタイプは以下のとおりです。

  • name - nameフィールドで定義されている、項目の名前。
  • description - descriptionフィールドで定義されている、項目の説明。
  • file_content - ファイルの実際のコンテンツ。
  • comments - ファイルまたはフォルダに対するコメントのコンテンツ。
  • tags - tagsフィールドで定義されている、項目に適用されるタグ。
利用可能なオプション:
name,
description,
file_content,
comments,
tag
​
type
enum<string>

このタイプの項目に検索結果を絞り込みます。このパラメータが受け取る値は1つだけです。デフォルトでは、このAPIによって、以下のいずれかのタイプと一致する項目が返されます。

  • file - 検索結果をファイルに絞り込みます。
  • folder - 検索結果をフォルダに絞り込みます。
  • web_link - 検索結果をウェブリンク (ブックマークとも呼ばれます) に絞り込みます。
利用可能なオプション:
file,
folder,
web_link
​
trash_content
enum<string>
デフォルト:non_trashed_only

検索時にごみ箱で項目を探すかどうかを決定します。

デフォルトでは、このAPIで返されるのは、現在ごみ箱にない項目の検索結果のみです (non_trashed_only)。

  • trashed_only - 現在ごみ箱にある項目のみを検索します。
  • non_trashed_only - 現在ごみ箱にない項目のみを検索します。
  • all_items - ごみ箱内の項目とごみ箱にない項目の両方を検索します。
利用可能なオプション:
non_trashed_only,
trashed_only,
all_items
​
mdfilters
メタデータフィルタ · object[]

指定したフィルタとメタデータが一致する項目のみに検索結果を絞り込みます。このパラメータは、検索結果のフィルタに使用するメタデータテンプレートを1つだけ指定するリストです。このパラメータは、queryパラメータが指定されていない場合に必須です。

Required array length: 1 element
​
sort
enum<string>
デフォルト:relevance

結果が返される順序を定義します。このパラメータが明示的に指定されていない限り、このAPIはデフォルトで、関連度を基準として項目を返します。

  • relevance (デフォルト) を指定すると、クエリの検索語句との関連度を基準として並べ替えられた結果が返されます。関連度は、項目の名前、説明、コンテンツ、およびその他のプロパティでの検索語句の出現回数に基づきます。
  • modified_atを指定すると、項目が最後に変更された日付を基準にして降順で並べ替えられた結果が返されます。
利用可能なオプション:
modified_at,
relevance
​
direction
enum<string>
デフォルト:DESC

検索結果の並べ替えの方向を定義します。このパラメータが明示的に指定されていない限り、このAPIはデフォルトで、降順 (DESC) で項目を返します。

結果がrelevanceを基準にして並べ替えられると、関連度の降順で項目が返されるよう並べ替えはロックされ、このパラメータは無視されます。

利用可能なオプション:
DESC,
ASC
​
limit
integer<int64>
デフォルト:30

結果ページの一部として返す項目の最大数を定義します。

必須範囲: x <= 200
​
include_recent_shared_links
boolean
デフォルト:false

ユーザーが最近共有リンクを介してアクセスした項目を検索結果に含めるかどうかを定義します。

このパラメータがtrueに設定されている場合は、共有リンクを含む検索結果のリストを返すよう、このAPIのレスポンス形式が変更されます。

​
fields
string[]

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

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

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

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

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

​
deleted_user_ids
string[]

指定したユーザーリスト (ユーザーIDのコンマ区切りリストとして定義) によって削除された項目に検索結果を絞り込みます。

trash_contentパラメータはtrashed_onlyに設定する必要があります。

ごみ箱内検索が実行されていない場合は、空の結果セットが返されます。検索結果に項目が表示されるように、項目は現在認証されているユーザーによって所有または共有されている必要があります。

いずれかのユーザーが所有するファイルにユーザーがアクセスできない場合は、空の結果セットが返されます。

2023年2月1日以降利用できるデータです。

​
deleted_at_range
string[]

指定した日付範囲内に削除されたすべての項目に検索結果を絞り込みます。

日付範囲はコンマ区切りのRFC3339タイムスタンプとして定義されます。

開始日が省略されている場合 (2014-05-17T13:35:01-07:00)、終了日より前に削除された項目がすべて返されます。

終了日が省略されている場合 (2014-05-15T13:35:01-07:00)、代わりに現在の日付が終了日として使用されます。

trash_contentパラメータはtrashed_onlyに設定する必要があります。

ごみ箱内検索が実行されていない場合は、空の結果が返されます。

2023年2月1日以降利用できるデータです。

レスポンス

検索結果のコレクションを返します。一致する検索結果がない場合、entries配列は空になります。

コンテンツの検索エンドポイントからの検索結果。 検索クエリに一致するファイル、フォルダ、およびウェブリンクのリスト。

​
type
enum<string>
必須

共有リンクを含まない検索結果項目としてレスポンスを指定します。

利用可能なオプション:
search_results_items
例:

"search_results_items"

​
total_count
integer<int64>

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

例:

5000

​
limit
integer<int64>

この検索で使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。

例:

1000

​
offset
integer<int64>

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

例:

2000

​
entries
検索結果の項目 · object[]

指定されたクエリの検索結果。

検索結果の項目。ファイル、フォルダ、またはウェブリンクの場合があります。 任意のファイルAPIエンドポイントからデフォルトで返される可能性があるファイルのFull版の表示。 任意のファイルAPIエンドポイントからデフォルトで返されるファイルのStandard版の表示。 他のリソースの下にネストされたときに使用されるファイルのMini版の表示。 最も基本的なファイルのBase版の表示。fieldsクエリパラメータを使用すると、最小限の数のフィールドが返されます。