Box Developer Documentation
Log in

Box Hub

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

This resource has a few variations that can be encountered when using the API.

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

string
12345

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.

string
hubs

The value will always be hubs.

Value is always hubs

boolean
true

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

boolean
true

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

string (date-time)
2012-12-12T10:53:43Z

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.

object

The user who created this Box Hub.

string
11446498

The unique identifier for this user.

string
user

The value will always be user.

Value is always user

string (email)
ceo@example.com

The primary email address of this user.

string
Aaron Levie
50

The display name of this user.

string
All the contracts for the company.

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

boolean
true

Indicates if AI features are enabled for the Box Hub.

boolean
true

Indicates if collaboration is restricted to the enterprise.

string
Contracts

The title given to the Box Hub.

string (date-time)
2012-12-12T10:53:43Z

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

object

The user who last modified this Box Hub.

string
11446498

The unique identifier for this user.

string
user

The value will always be user.

Value is always user

string (email)
ceo@example.com

The primary email address of this user.

string
Aaron Levie
50

The display name of this user.

integer (int32)
506

The number of views for the Box Hub.

Response Example

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