リクエストしている企業のすべてのBox Hubのリストを取得

cURL

curl --request GET \
  --url https://api.box.com/2.0/enterprise_hubs \
  --header 'Authorization: Bearer <token>' \
  --header 'box-version: <box-version>'

{
  "entries": [
    {
      "id": "12345",
      "type": "hubs",
      "title": "Contracts",
      "description": "All the contracts for the company.",
      "created_at": "2012-12-12T10:53:43Z",
      "updated_at": "2012-12-12T10:53:43Z",
      "created_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "updated_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "view_count": 506,
      "is_ai_enabled": true,
      "is_collaboration_restricted_to_enterprise": true,
      "can_non_owners_invite": true,
      "can_shared_link_be_created": true
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}

GET

enterprise_hubs

cURL

curl --request GET \
  --url https://api.box.com/2.0/enterprise_hubs \
  --header 'Authorization: Bearer <token>' \
  --header 'box-version: <box-version>'

{
  "entries": [
    {
      "id": "12345",
      "type": "hubs",
      "title": "Contracts",
      "description": "All the contracts for the company.",
      "created_at": "2012-12-12T10:53:43Z",
      "updated_at": "2012-12-12T10:53:43Z",
      "created_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "updated_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "view_count": 506,
      "is_ai_enabled": true,
      "is_collaboration_restricted_to_enterprise": true,
      "can_non_owners_invite": true,
      "can_shared_link_be_created": true
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}

「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

Authorization

string

header

required

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

Headers

box-version

enum<string>

required

Version header.

利用可能なオプション:

2025.0

Query Parameters

query

string

Box Hubを検索するためのクエリ文字列。

sort

string

default:relevance

結果の並べ替えに使用するフィールド。使用可能な値には、name、updated_at、last_accessed_at、view_count、relevanceがあります。デフォルトはrelevanceです。

direction

enum<string>

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

利用可能なオプション:

ASC,

DESC

marker

string

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

limit

integer<int64>

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

必須範囲: x <= 1000

Response

指定したユーザーまたは企業のすべてのBox Hubを返します。

Hubのページ割りされたリスト。マーカーベースのページネーションについて説明しているAPIレスポンスの部分。

entries

Box Hub · object[]

Hubのリスト。

表示子属性

entries.id

string

required

Box Hubを表す一意の識別子。

Box HubのIDを確認するには、ウェブアプリでBox Hubにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/hubs/123の場合、hub_idは123です。

Example:

"12345"

entries.type

enum<string>

required

値は常にhubsになります。

利用可能なオプション:

hubs

Example:

"hubs"

entries.title

string

Box Hubのタイトル。

Example:

"Contracts"

entries.description

string

Box Hubの説明。最初の200文字が返されます。

Example:

"All the contracts for the company."

entries.created_at

string<date-time>

このフォルダが作成された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになる場合があります。

Example:

"2012-12-12T10:53:43Z"

entries.updated_at

string<date-time>

Box Hubが最後に更新された日時。

Example:

"2012-12-12T10:53:43Z"

entries.created_by

ユーザー (Mini) · object

このBox Hubを作成したユーザー。

表示子属性

entries.created_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

entries.created_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

entries.created_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

entries.updated_by

ユーザー (Mini) · object

このBox Hubを最後に変更したユーザー。

表示子属性

entries.updated_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

entries.updated_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

entries.updated_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

entries.view_count

integer<int32>

Box Hubの表示回数。

Example:

506

entries.is_ai_enabled

boolean

AI機能がBox Hubに対して有効になっているかどうかを示します。

Example:

true

entries.is_collaboration_restricted_to_enterprise

boolean

コラボレーションが企業に制限されているかどうかを示します。

Example:

true

entries.can_non_owners_invite

boolean

所有者以外のユーザーが他のユーザーをBox Hubに招待できるかどうかを示します。

Example:

true

entries.can_shared_link_be_created

boolean

Box Hubに対して共有リンクを作成できるかどうかを示します。

Example:

true

limit

integer<int64>

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

Example:

1000

next_marker

string | null

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

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"

Box Hubs

IDを指定してBox Hubの情報を取得

⌘I