Box Developerドキュメント
ログイン
ベータ

List all hubs

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

Retrieves all hubs for requesting user.

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエストヘッダー

stringヘッダー内必須

Version header.

次の値に固定: 2025.0

クエリパラメータ

stringクエリ内省略可能
ASC

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

次の値のいずれか1つ: ASC,DESC

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

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

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

stringクエリ内省略可能
Box

The query string to search for hubs.

stringクエリ内省略可能
all
"all"

The scope of the hubs to retrieve. Possible values include editable, view_only, and all. Default is all.

stringクエリ内省略可能
name
"relevance"

The field to sort results by. Possible values include name, updated_at, last_accessed_at, view_count, and relevance. Default is relevance.

レスポンス

application/jsonHubs

Returns all hubs for the given user or enterprise.

application/jsonクライアントエラー

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

get
List all hubs
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

TypeScript Gen
await client.hubs.getHubsV2025R0({
  scope: 'all',
  sort: 'name',
  direction: 'ASC' as GetHubsV2025R0QueryParamsDirectionField,
} satisfies GetHubsV2025R0QueryParams);
Python Gen
client.hubs.get_hubs_v2025_r0(
    scope="all", sort="name", direction=GetHubsV2025R0Direction.ASC
)
.NET Gen
await client.Hubs.GetHubsV2025R0Async(queryParams: new GetHubsV2025R0QueryParams() { Scope = "all", Sort = "name", Direction = GetHubsV2025R0QueryParamsDirectionField.Asc });

レスポンスの例

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