Skip to main content

A Box Hub collaboration object grants a user or group access to a Box Hub with permissions defined by a specific role.

id
string
required

The unique identifier for this collaboration.

Example:

"12345678"

type
enum<string>
required

The value will always be hub_collaboration.

Available options:
hub_collaboration
Example:

"hub_collaboration"

hub
Box Hub (Base) · object

The bare basic representation of a Box Hub.

accessible_by
Box Hub Collaboration User · object

A mini representation of a user, can be returned only when the status is pending.

role
string

The level of access granted to a Box Hub. Possible values are editor, viewer, and co-owner.

Example:

"editor"

status
enum<string>

The status of the collaboration invitation. If the status is pending, login and name return an empty string.

Available options:
accepted,
pending,
rejected
Example:

"accepted"

acceptance_requirements_status
object