Box開発者向けドキュメントポータル
ログイン

APIリファレンス

Classifications
リソースの一覧
分類分類テンプレート
エンドポイント
GETすべての分類のリストを取得POST最初の分類を追加PUT分類を追加PUT分類を更新PUT分類を削除DELすべての分類を削除
Collaborations
リソースの一覧
CollaborationCollaborations
エンドポイント
GETコラボレーションを取得POSTコラボレーションを作成PUTコラボレーションを更新DELコラボレーションを削除
Collections
リソースの一覧
CollectionCollections
エンドポイント
GETすべてのコレクションのリストを取得GETコレクション項目のリストを取得
Comments
リソースの一覧
Commentコメント (Base)Commentsコメント (Full)
エンドポイント
GETファイルのコメントのリストを取得GETコメントを取得POSTコメントを作成PUTコメントを更新DELコメントを削除
Device Pinner
リソースの一覧
Device PinnerDevice Pinner
エンドポイント
GETデバイスピンを取得GET会社のデバイスピンのリストを取得DELデバイスピンを削除
Events
リソースの一覧
EventEventsリアルタイムサーバー
エンドポイント
GETUser EventおよびEnterprise Eventのリストを取得OPTSイベントのLong pollingエンドポイントを取得
Files
リソースの一覧
FileFilesファイル (Full)ファイル (Base)ファイル (Mini)
エンドポイント
GETファイル情報を取得GETファイルサムネイルを取得POSTファイルをコピーPUTファイルを更新DELファイルを削除
Folders
リソースの一覧
Folderフォルダ (Full)フォルダ (Base)フォルダ (Mini)Items
エンドポイント
GETフォルダ情報を取得GETフォルダ内の項目のリストを取得POSTフォルダを作成POSTフォルダをコピーPUTフォルダを更新DELフォルダを削除
Groups
リソースの一覧
GroupGroupsグループ (Base)グループ (Full)グループ (Mini)
エンドポイント
GET会社のグループのリストを取得GETグループを取得POSTグループを作成PUTグループを更新DELグループを削除
Integration mappings
リソースの一覧
Integration mappingIntegration mapping (Base)Integration mapping (Mini)Integration mappings
エンドポイント
GETList Slack integration mappingsPOSTCreate Slack integration mappingPUTUpdate Slack integration mappingDELDelete Slack integration mapping
Invites
リソースの一覧
Invite
エンドポイント
GETユーザー招待ステータスを取得POSTユーザー招待を作成
Shield情報バリア
リソースの一覧
Shield情報バリアShield情報バリア (Base)
エンドポイント
GET指定したIDのShield情報バリアを取得GETShield情報バリアのリストを取得POST指定したIDのShield情報バリアの変更されたステータスを追加POSTShield情報バリアを作成
Shield情報バリアのセグメント
リソースの一覧
Shield情報バリアのセグメント
エンドポイント
GET指定したIDのShield情報バリアのセグメントを取得GETShield情報バリアのセグメントのリストを取得POSTShield情報バリアのセグメントを作成PUT指定したIDのShield情報バリアのセグメントを更新DELShield情報バリアのセグメントを削除
Shield情報バリアのセグメントメンバー
リソースの一覧
Shield情報バリアのセグメントメンバーShield情報バリアのセグメントメンバー (Base)Shield情報バリアのセグメントメンバー (Mini)
エンドポイント
GETIDを指定してShield情報バリアのセグメントメンバーを取得GETShield情報バリアのセグメントメンバーのリストを取得POSTShield情報バリアのセグメントメンバーを作成DELIDを指定してShield情報バリアのセグメントメンバーを削除
Shield情報バリアのセグメント制限
リソースの一覧
Shield情報バリアのセグメント制限Shield情報バリアのセグメント制限 (Base)Shield情報バリアのセグメント制限 (Mini)
エンドポイント
GETIDを指定してShield情報バリアのセグメント制限を取得GETShield情報バリアのセグメント制限のリストを取得POSTShield情報バリアのセグメント制限を作成DELIDを指定してShield情報バリアのセグメント制限を削除
Shield情報バリアレポート
リソースの一覧
Shield情報バリアレポートShield情報バリアレポート (Base)Shield情報バリア参照Shield情報バリアレポートの詳細
エンドポイント
GETShield情報バリアレポートのリストを取得GETIDを指定してShield情報バリアレポートを取得POSTShield情報バリアレポートを作成
Signテンプレート
リソースの一覧
Box SignテンプレートBox Signテンプレート
エンドポイント
GETBox Signテンプレートのリストを取得GETIDを指定してBox Signテンプレートを取得
Skills
リソースの一覧
スキルのWebhookペイロードSkillsメタデータインスタンスキーワードスキルカードタイムラインスキルカードトランスクリプトスキルカードステータススキルカード
エンドポイント
GETファイルのBox Skillカードのリストを取得POSTファイルにBox Skillカードを作成PUTファイルのBox Skillカードを更新PUTファイルのすべてのBox Skillカードを更新DELファイルからBox Skillカードを削除
Tasks
リソースの一覧
TaskTasks
エンドポイント
GETファイルに対するタスクのリストを取得GETタスクを取得POSTタスクを作成PUTタスクを更新DELタスクを削除
Users
リソースの一覧
ユーザー (Base)UserUsersユーザー (Full)ユーザー (Mini)ユーザー (コラボレーション)User (Integration Mappings)
エンドポイント
GET会社ユーザーのリストを取得GET現在のユーザーを取得GETユーザーを取得POSTユーザーを作成PUTユーザーを更新DELユーザーを削除
Webhooks
リソースの一覧
Webhook (V2) ペイロードWebhook (Mini)WebhooksWebhook
エンドポイント
GETすべてのWebhookのリストを取得GETWebhookを取得POSTWebhookを作成PUTWebhookを更新DELWebhookを削除
zipダウンロード
リソースの一覧
zipダウンロードzipダウンロードのステータス
エンドポイント
GETzipアーカイブをダウンロードGETzipダウンロードのステータスを取得POSTzipダウンロードを作成
ごみ箱内のウェブリンク
リソースの一覧
ごみ箱内のウェブリンクごみ箱内のウェブリンク (復元済み)
エンドポイント
GETごみ箱に移動されたウェブリンクを取得POSTウェブリンクを復元DELウェブリンクを完全に削除
ごみ箱内のファイル
リソースの一覧
ごみ箱内のファイルごみ箱内のファイル (復元済み)
エンドポイント
GETごみ箱内のファイルを取得POSTファイルを復元DELファイルを完全に削除
ごみ箱内のフォルダ
リソースの一覧
ごみ箱内のフォルダごみ箱内のフォルダ (復元済み)
エンドポイント
GETごみ箱内のフォルダを取得POSTフォルダを復元DELフォルダを完全に削除
ごみ箱内の項目
エンドポイント
GETごみ箱内の項目のリストを取得
アップロード
リソースの一覧
競合エラーアップロードURL
エンドポイント
OPTSアップロード前の事前チェックPOSTファイルバージョンをアップロードPOSTファイルをアップロード
アップロード (分割)
リソースの一覧
Upload partパーツのアップロード (Mini)アップロードされたパーツUpload partアップロードセッション
エンドポイント
GETアップロードセッションを取得GETパーツのリストを取得POSTアップロードセッションを作成POST既存ファイルのアップロードセッションを作成POSTアップロードセッションをコミットPUTファイルの一部をアップロードDELアップロードセッションを削除
ウェブリンク
リソースの一覧
ウェブリンク (Base)ウェブリンク (Mini)ウェブリンク
エンドポイント
GETウェブリンクを取得POSTウェブリンクを作成PUTウェブリンクを更新DELウェブリンクを削除
グループメンバーシップ
リソースの一覧
グループメンバーシップグループメンバーシップ
エンドポイント
GETユーザーのグループのリストを取得GETグループのメンバーのリストを取得GETグループメンバーシップを取得POSTユーザーをグループに追加PUTグループメンバーシップを更新DELユーザーをグループから削除
コラボレーション (リスト)
エンドポイント
GETファイルのコラボレーションのリストを取得GETフォルダコラボレーションのリストを取得GET保留中のコラボレーションのリストを取得GETグループコラボレーションのリストを取得
コラボレーションに対するドメインを制限
リソースの一覧
許可されたコラボレーションドメイン許可されたコラボレーションドメイン
エンドポイント
GET許可されたコラボレーションドメインのリストを取得GET許可されたコラボレーションドメインを取得POST許可されたコラボレーションドメインのリストにドメインを追加DEL許可されたコラボレーションドメインのリストからドメインを削除
サービス利用規約
リソースの一覧
サービス利用規約サービス利用規約サービス利用規約 (Base)
エンドポイント
GETサービス利用規約のリストを取得GETサービス利用規約を取得POSTサービス利用規約を作成PUTサービス利用規約を更新
サービス利用規約のユーザーステータス
リソースの一覧
サービス利用規約のユーザーステータスサービス利用規約のユーザーステータス
エンドポイント
GETサービス利用規約のユーザーステータスのリストを取得POST新規ユーザーのサービス利用規約のステータスを作成PUT既存ユーザーのサービス利用規約のステータスを更新
セッション終了
リソースの一覧
セッション終了メッセージ
エンドポイント
POSTユーザーのセッションを終了させるジョブを作成POSTユーザーグループのセッションを終了させるジョブを作成
タスク割り当て
リソースの一覧
タスク割り当てタスク割り当て
エンドポイント
GETタスク割り当てのリストを取得GETタスク割り当てを取得POSTタスクを割り当てPUTタスク割り当てを更新DELタスク割り当てを解除
ダウンロード
エンドポイント
GETファイルをダウンロード
ドメインの制限 (ユーザーの除外)
リソースの一覧
許可されたコラボレーションドメインからユーザーを除外許可されたコラボレーションドメインからユーザーを除外
エンドポイント
GETコラボレーションドメインの制限から除外するユーザーのリストを取得GETコラボレーションドメインの制限から除外するユーザーを取得POSTコラボレーションドメインの制限からのユーザー除外を作成DELドメインの制限から除外されるユーザーのリストからユーザーを削除
ファイルの分類
エンドポイント
GETファイルの分類を取得POSTファイルに分類を追加PUTファイルの分類を更新DELファイルから分類を削除
ファイルバージョン
リソースの一覧
ファイルバージョン
エンドポイント
GETすべてのファイルバージョンのリストを取得GETファイルバージョンを取得POSTファイルバージョンを昇格PUTファイルバージョンを復元DELファイルバージョンを削除
ファイルバージョンのリーガルホールド
リソースの一覧
ファイルバージョンのリーガルホールドファイルバージョンのリーガルホールド
エンドポイント
GETファイルバージョンのリーガルホールドを取得GETファイルバージョンのリーガルホールドのリストを取得
ファイルバージョンリテンション
リソースの一覧
ファイルバージョンリテンションファイルバージョンリテンション
エンドポイント
GETファイルバージョンリテンションのリストを取得GETファイルのリテンションを取得
ファイルリクエスト
リソースの一覧
ファイルリクエスト
エンドポイント
GETファイルリクエストを取得POSTファイルリクエストをコピーPUTファイルリクエストを更新DELファイルリクエストを削除
フォルダの分類
エンドポイント
GETフォルダの分類を取得POSTフォルダに分類を追加PUTフォルダの分類を更新DELフォルダから分類を削除
フォルダを移行
エンドポイント
PUT所有フォルダを移行
フォルダロック
リソースの一覧
フォルダロックフォルダロック
エンドポイント
GETフォルダロックのリストを取得POSTフォルダロックを作成DELフォルダロックを削除
メタデータインスタンス (ファイル)
リソースの一覧
メタデータインスタンスメタデータインスタンス (Full)メタデータインスタンス (Base)メタデータインスタンス
エンドポイント
GETファイルのメタデータインスタンスのリストを取得GETファイルのメタデータインスタンスを取得POSTファイルにメタデータインスタンスを作成PUTファイルのメタデータインスタンスを更新DELファイルからメタデータインスタンスを削除
メタデータインスタンス (フォルダ)
エンドポイント
GETフォルダのメタデータインスタンスのリストを取得GETフォルダのメタデータインスタンスを取得POSTフォルダにメタデータインスタンスを作成PUTフォルダのメタデータインスタンスを更新DELフォルダからメタデータインスタンスを削除
メタデータカスケードポリシー
リソースの一覧
メタデータカスケードポリシーメタデータカスケードポリシー
エンドポイント
GETメタデータカスケードポリシーのリストを取得GETメタデータカスケードポリシーを取得POSTフォルダにメタデータカスケードポリシーを強制適用POSTメタデータカスケードポリシーを作成DELメタデータカスケードポリシーを削除
メタデータテンプレート
リソースの一覧
メタデータテンプレートメタデータテンプレート
エンドポイント
GETインスタンスIDでメタデータテンプレートを検索GET名前を指定してメタデータテンプレートを取得GETIDを指定してメタデータテンプレートを取得GETすべてのグローバルメタデータテンプレートのリストを取得GET企業のすべてのメタデータテンプレートのリストを取得POSTメタデータテンプレートを作成PUTメタデータテンプレートを更新DELメタデータテンプレートを削除
メールエイリアス
リソースの一覧
メールエイリアスメールエイリアス
エンドポイント
GETユーザーのメールエイリアスのリストを取得POSTメールエイリアスを作成DELメールエイリアスを削除
ユーザーのアバター
リソースの一覧
ユーザーのアバター
エンドポイント
GETユーザーのアバターを取得POSTユーザーのアバターを追加または更新DELユーザーのアバターを削除
リテンションポリシー
リソースの一覧
リテンションポリシーリテンションポリシー (Mini)リテンションポリシー (Base)リテンションポリシー
エンドポイント
GETリテンションポリシーのリストを取得GETリテンションポリシーを取得POSTリテンションポリシーを作成PUTリテンションポリシーを更新DELリテンションポリシーを削除
リテンションポリシー割り当て
リソースの一覧
リテンションの対象となるファイルリテンションポリシー割り当て (Base)リテンションポリシー割り当てリテンションポリシー割り当て
エンドポイント
GETリテンションポリシー割り当てのリストを取得GETリテンションポリシー割り当てを取得GETリテンションの対象となるファイルを取得GETリテンションの対象となるファイルバージョンを取得POSTリテンションポリシーを割り当てDELリテンションポリシー割り当てを削除
リーガルホールドポリシー
リソースの一覧
リーガルホールドポリシー (Mini)リーガルホールドポリシーリーガルホールドポリシー
エンドポイント
GETすべてのリーガルホールドポリシーのリストを取得GETリーガルホールドポリシーを取得POSTリーガルホールドポリシーを作成PUTリーガルホールドポリシーを更新DELリーガルホールドポリシーを削除
リーガルホールドポリシー割り当て
リソースの一覧
リーガルホールドポリシー割り当て (Base)リーガルホールドポリシー割り当てリーガルホールドポリシー割り当て
エンドポイント
GETリーガルホールドポリシー割り当てのリストを取得GETリーガルホールドポリシー割り当てを取得GETリーガルホールドポリシー割り当てに関する現在のファイルバージョンのリストを取得GETリーガルホールドポリシー割り当てに関する以前のファイルバージョンのリストを取得POSTリーガルホールドポリシーを割り当てDELリーガルホールドポリシーの割り当てを解除
ワークフロー (リスト)
リソースの一覧
Workflowワークフロー (Full)ワークフロー (Mini)ワークフロー (リスト)
エンドポイント
GETワークフローのリストを取得POSTリクエスト本文に基づいてワークフローを開始
共有リンク (ウェブリンク)
エンドポイント
GET共有リンクのウェブリンクを検索GETウェブリンクの共有リンクを取得PUTウェブリンクに共有リンクを追加PUTウェブリンクの共有リンクを更新PUTウェブリンクから共有リンクを削除
共有リンク (ファイル)
エンドポイント
GET共有リンクのファイルを検索GETファイルの共有リンクを取得PUTファイルに共有リンクを追加PUTファイルの共有リンクを更新PUTファイルから共有リンクを削除
共有リンク (フォルダ)
エンドポイント
GET共有リンクのフォルダを検索GETフォルダの共有リンクを取得PUTフォルダに共有リンクを追加PUTフォルダの共有リンクを更新PUTフォルダから共有リンクを削除
承認
リソースの一覧
OAuth 2.0エラーアクセストークン
エンドポイント
GETユーザーを承認POSTアクセストークンを取り消しPOSTアクセストークンをリクエストPOSTアクセストークンを更新
最近使用した項目
リソースの一覧
最近使用した項目
エンドポイント
GET最近アクセスした項目のリストを取得
検索
リソースの一覧
Metadata query indexMetadata query indicesメタデータクエリの検索結果検索結果検索結果 (複数の共有リンクを含む)検索結果 (共有リンクを含む)メタデータフィルタ
エンドポイント
GETメタデータクエリインデックスのリストを取得GETコンテンツを検索POSTメタデータによるファイル/フォルダに対するクエリ
標準およびZonesのストレージポリシー
リソースの一覧
ストレージポリシーストレージポリシーストレージポリシー (Mini)
エンドポイント
GETストレージポリシーのリストを取得GETストレージポリシーを取得
標準およびZonesのストレージポリシー割り当て
リソースの一覧
ストレージポリシー割り当てストレージポリシー割り当て
エンドポイント
GETストレージポリシー割り当てのリストを取得GETストレージポリシー割り当てを取得POSTストレージポリシーを割り当てPUTストレージポリシー割り当てを更新DELストレージポリシーの割り当てを解除
署名リクエスト
リソースの一覧
署名リクエスト署名リクエスト署名リクエスト (Base)
エンドポイント
GETIDを指定して署名リクエストを取得GET署名リクエストのリストを取得POST署名リクエストを再送信POST署名リクエストをキャンセルPOST署名リクエストを作成
電子すかし (ファイル)
リソースの一覧
Watermark
エンドポイント
GETファイルの電子すかしを取得PUTファイルに電子すかしを適用DELファイルから電子すかしを削除
電子すかし (フォルダ)
エンドポイント
GETフォルダの電子すかしを取得PUTフォルダに電子すかしを適用DELフォルダから電子すかしを削除
リソースの一覧
アクセストークン分類分類テンプレートクライアントエラーCollaboration許可されたコラボレーションドメイン許可されたコラボレーションドメイン許可されたコラボレーションドメインからユーザーを除外許可されたコラボレーションドメインからユーザーを除外Collaborations
CollectionCollectionsCommentコメント (Base)コメント (Full)Comments競合エラーDevice PinnerDevice Pinnerメールエイリアス
メールエイリアス企業 (Base)EventイベントソースEventsFileファイル (Base)ファイル (Full)ファイル (Mini)ファイル (競合)
ファイルリクエストファイルバージョンファイルバージョン (Base)ファイルバージョン (Full)ファイルバージョン (Mini)ファイルバージョンのリーガルホールドファイルバージョンのリーガルホールドファイルバージョンリテンションファイルバージョンリテンションファイルバージョン
Filesリテンションの対象となるファイルFolderフォルダ (Base)フォルダ (Full)フォルダ (Mini)フォルダロックフォルダロックGroupグループ (Base)
グループ (Full)グループ (Mini)グループメンバーシップグループメンバーシップGroupsIntegration mappingIntegration mapping (Base)Integration mapping (Mini)Create integration mapping requestIntegration mappings
InviteItemsキーワードスキルカードリーガルホールドポリシーリーガルホールドポリシーリーガルホールドポリシー (Mini)リーガルホールドポリシー割り当てリーガルホールドポリシー割り当て (Base)リーガルホールドポリシー割り当てメタデータインスタンス
メタデータインスタンス (Base)メタデータインスタンス (Full)メタデータカスケードポリシーメタデータカスケードポリシーメタデータフィールドのフィルタ (日付範囲)メタデータフィールドのフィルタ (浮動小数点)メタデータフィールドのフィルタ (浮動小数点の範囲)メタデータフィールドのフィルタ (複数選択)メタデータフィールドのフィルタ (文字列)メタデータフィルタ
Metadata query indexMetadata query indicesメタデータクエリの検索結果メタデータテンプレートメタデータテンプレートメタデータインスタンスOAuth 2.0エラーリアルタイムサーバーリアルタイムサーバー最近使用した項目
最近使用した項目リテンションポリシーリテンションポリシーリテンションポリシー (Base)リテンションポリシー (Mini)リテンションポリシー割り当てリテンションポリシー割り当て (Base)リテンションポリシー割り当て検索結果 (共有リンクを含む)検索結果
検索結果 (複数の共有リンクを含む)セッション終了メッセージShield情報バリアShield情報バリア (Base)Shield情報バリア参照Shield情報バリアレポートShield情報バリアレポート (Base)Shield情報バリアレポートの詳細Shield情報バリアのセグメントShield情報バリアのセグメントメンバー
Shield情報バリアのセグメントメンバー (Base)Shield情報バリアのセグメントメンバー (Mini)Shield情報バリアのセグメント制限Shield情報バリアのセグメント制限 (Base)Shield情報バリアのセグメント制限 (Mini)署名リクエスト署名リクエスト (Base)署名リクエストBox SignテンプレートBox Signテンプレート
SkillsメタデータインスタンススキルのWebhookペイロードステータススキルカードストレージポリシーストレージポリシーストレージポリシー (Mini)ストレージポリシー割り当てストレージポリシー割り当てTaskタスク割り当て
タスク割り当てTasksサービス利用規約サービス利用規約 (Base)サービス利用規約のユーザーステータスサービス利用規約サービス利用規約のユーザーステータスタイムラインスキルカードトランスクリプトスキルカードごみ箱内のファイル
ごみ箱内のファイル (復元済み)ごみ箱内のフォルダごみ箱内のフォルダ (復元済み)ごみ箱内のウェブリンクごみ箱内のウェブリンク (復元済み)Upload partパーツのアップロード (Mini)Upload partアップロードセッションアップロードURL
アップロードされたパーツUserユーザー (Base)ユーザー (Full)ユーザー (Mini)ユーザーのアバターユーザー (コラボレーション)User (Integration Mappings)UsersWatermark
ウェブリンクウェブリンク (Base)ウェブリンク (Mini)WebhookWebhook (Mini)Webhook (V2) ペイロードWebhooksWorkflowワークフロー (Full)ワークフロー (Mini)
ワークフロー (リスト)zipダウンロードzipダウンロードのステータス