Skip to main content
POST
/
hubs
cURL
curl --request POST \
  --url https://api.box.com/2.0/hubs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'box-version: <box-version>' \
  --data '
{
  "title": "Hub Title",
  "description": "This is a description of the Box Hub."
}
'
{
  "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
}
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

Body

application/json

Request schema for creating a new Box Hub.

​
title
string
required

Title of the Box Hub. It cannot be empty and should be less than 50 characters.

Maximum string length: 50
Example:

"Hub Title"

​
description
string

Description of the Box Hub.

Example:

"This is a description of the Box Hub."

Response

Returns a new Hub object.

A standard representation of a Box Hub, as returned from any Box Hubs API endpoints by default.

​
id
string
required

The unique identifier that represent a Box Hub.

The ID for any Box Hub can be determined by visiting a Box Hub in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/hubs/123 the hub_id is 123.

Example:

"12345"

​
type
enum<string>
required

The value will always be hubs.

Available options:
hubs
Example:

"hubs"

​
title
string

The title given to the Box Hub.

Example:

"Contracts"

​
description
string

The description of the Box Hub. First 200 characters are returned.

Example:

"All the contracts for the company."

​
created_at
string<date-time>

The date and time when the folder was created. This value may be null for some folders such as the root folder or the trash folder.

Example:

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

​
updated_at
string<date-time>

The date and time when the Box Hub was last updated.

Example:

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

​
created_by
User (Mini) · object

The user who created this Box Hub.

​
updated_by
User (Mini) · object

The user who last modified this Box Hub.

​
view_count
integer<int32>

The number of views for the Box Hub.

Example:

506

​
is_ai_enabled
boolean

Indicates if AI features are enabled for the Box Hub.

Example:

true

​
is_collaboration_restricted_to_enterprise
boolean

Indicates if collaboration is restricted to the enterprise.

Example:

true

​
can_non_owners_invite
boolean

Indicates if non-owners can invite others to the Box Hub.

Example:

true

​
can_shared_link_be_created
boolean

Indicates if a shared link can be created for the Box Hub.

Example:

true