Box Developer Documentation
Log in
Latest version

List all Box Hubs

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

Retrieves all Box Hubs for requesting user.

Request

bearer [ACCESS_TOKEN]
application/json

Request Headers

stringin headerrequired

Version header.

Value is always 2025.0

Query Parameters

stringin queryoptional
ASC

The direction to sort results in. This can be either in alphabetical ascending (ASC) or descending (DESC) order.

Value is one of ASC,DESC

integer (int64)in queryoptional
1000
1000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

stringin queryoptional
Box

The query string to search for Box Hubs.

stringin queryoptional
all
"all"

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

stringin queryoptional
name
"relevance"

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

Response

application/jsonBox Hubs

Returns all Box Hubs for the given user or enterprise.

application/jsonClient error

An unexpected client error.

get
List all Box Hubs
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


Node/TypeScript v10
await client.hubs.getHubsV2025R0({
  scope: 'all',
  sort: 'name',
  direction: 'ASC' as GetHubsV2025R0QueryParamsDirectionField,
} satisfies GetHubsV2025R0QueryParams);
Python v10
client.hubs.get_hubs_v2025_r0(
    scope="all", sort="name", direction=GetHubsV2025R0Direction.ASC
)
.NET v10
await client.Hubs.GetHubsV2025R0Async(queryParams: new GetHubsV2025R0QueryParams() { Scope = "all", Sort = "name", Direction = GetHubsV2025R0QueryParamsDirectionField.Asc });
Swift v10
try await client.hubs.getHubsV2025R0(queryParams: GetHubsV2025R0QueryParams(scope: "all", sort: "name", direction: GetHubsV2025R0QueryParamsDirectionField.asc))
Java v10
client.getHubs().getHubsV2025R0(new GetHubsV2025R0QueryParams.Builder().scope("all").sort("name").direction(GetHubsV2025R0QueryParamsDirectionField.ASC).build())

Response Example

{
  "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"
}