Skip to main content
GET
/
hubs
cURL
curl --request GET \
  --url https://api.box.com/2.0/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": "[email protected]"
      },
      "updated_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "[email protected]"
      },
      "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"
}
Learn more about Box SDK versioning strategy.

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.

Available options:
2025.0

Query Parameters

​
query
string

The query string to search for Box Hubs.

​
scope
string
default:all

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

​
sort
string
default:relevance

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

​
direction
enum<string>

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

Available options:
ASC,
DESC
​
marker
string

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

​
limit
integer<int64>

The maximum number of items to return per page.

Required range: x <= 1000

Response

Returns all Box Hubs for the given user or enterprise.

A paginated list of hubs.

​
entries
Box Hub · object[]

A list of hubs.

​
limit
integer<int64>

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

Example:

1000

​
next_marker
string | null

The marker for the start of the next page of results.

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"