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

    保留中のコラボレーションのリストを取得

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

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

    このユーザーに関連する保留中のコラボレーション招待をすべて取得します。

    リクエスト

    bearer [ACCESS_TOKEN]
    application/json

    クエリパラメータ

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

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

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

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

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

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

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

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

    stringクエリ内必須
    pending

    取得するコラボレーションのステータス

    次の値に固定: pending

    レスポンス

    application/jsonCollaborations

    保留中のコラボレーションオブジェクトのコレクションを返します。

    ユーザーに保留中のコラボレーションがない場合、このコレクションは空になります。

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

    get
    保留中のコラボレーションのリストを取得
    このドキュメント内で一部のAPIを試せるようになりました。
    ログイン

    リクエストの例

    cURL
    curl -i -X GET "https://api.box.com/2.0/collaborations?status=pending" \
         -H "authorization: Bearer <ACCESS_TOKEN>"

    レスポンスの例

    {
      "entries": [
        {
          "acceptance_requirements_status": {
            "strong_password_requirement": {
              "enterprise_has_strong_password_required_for_external_users": true,
              "user_has_strong_password": true
            },
            "terms_of_service_requirement": {
              "is_accepted": true,
              "terms_of_service": {
                "id": "11446498",
                "type": "terms_of_service"
              }
            },
            "two_factor_authentication_requirement": {
              "enterprise_has_two_factor_auth_enabled": true,
              "user_has_two_factor_authentication_enabled": true
            }
          },
          "accessible_by": {
            "id": "11446498",
            "type": "user",
            "is_active": true,
            "login": "ceo@example.com",
            "name": "Aaron Levie"
          },
          "acknowledged_at": "2012-12-12T10:55:20-08:00",
          "app_item": {
            "application_type": "hubs",
            "id": "12345678",
            "type": "app_item"
          },
          "created_at": "2012-12-12T10:53:43-08:00",
          "created_by": [
            {
              "id": 33224412
            },
            {
              "type": "user"
            },
            {
              "login": "dylan@example.com"
            },
            {
              "name": "Dylan Smith"
            }
          ],
          "expires_at": "2012-12-26T10:53:43-08:00",
          "id": "12345678",
          "invite_email": "john@example.com",
          "is_access_only": true,
          "item": {
            "etag": "1",
            "id": "12345",
            "type": "file",
            "file_version": {
              "id": "12345",
              "type": "file_version",
              "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
            },
            "name": "Contract.pdf",
            "sequence_id": "3",
            "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
            "content_created_at": "2012-12-12T10:53:43-08:00",
            "content_modified_at": "2012-12-12T10:53:43-08:00",
            "created_at": "2012-12-12T10:53:43-08:00",
            "created_by": {
              "id": "11446498",
              "type": "user",
              "login": "ceo@example.com",
              "name": "Aaron Levie"
            },
            "description": "Contract for Q1 renewal",
            "item_status": "active",
            "modified_at": "2012-12-12T10:53:43-08:00",
            "modified_by": {
              "id": "11446498",
              "type": "user",
              "login": "ceo@example.com",
              "name": "Aaron Levie"
            },
            "owned_by": {
              "id": "11446498",
              "type": "user",
              "login": "ceo@example.com",
              "name": "Aaron Levie"
            },
            "parent": {
              "etag": "1",
              "id": "12345",
              "type": "folder",
              "name": "Contracts",
              "sequence_id": "3"
            },
            "path_collection": {
              "entries": [
                {
                  "etag": "1",
                  "id": "12345",
                  "type": "folder",
                  "name": "Contracts",
                  "sequence_id": "3"
                }
              ],
              "total_count": 1
            },
            "purged_at": "2012-12-12T10:53:43-08:00",
            "shared_link": {
              "access": "open",
              "download_count": 3,
              "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
              "effective_access": "company",
              "effective_permission": "can_download",
              "is_password_enabled": true,
              "permissions": {
                "can_download": true,
                "can_edit": false,
                "can_preview": true
              },
              "preview_count": 3,
              "unshared_at": "2018-04-13T13:53:23-07:00",
              "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
              "vanity_name": "my_url",
              "vanity_url": "https://acme.app.box.com/v/my_url/"
            },
            "size": 629644,
            "trashed_at": "2012-12-12T10:53:43-08:00"
          },
          "modified_at": "2012-12-12T10:53:43-08:00",
          "role": "editor",
          "status": "accepted",
          "type": "collaboration"
        }
      ],
      "limit": 1000,
      "offset": 2000,
      "total_count": 5000
    }