Skip to main content
API version 2025.0 A Box Hub collaboration object grants a user or group access to a Box Hub with permissions defined by a specific role.
id
string
example: 12345678The unique identifier for this collaboration.
type
string
example: hub_collaborationThe value will always be hub_collaboration.Value is always hub_collaboration
acceptance_requirements_status
object
accessible_by
objectobject
The user or group that is granted access.
hub
Box Hub (Base)object
The bare basic representation of a Box Hub.
role
string
example: editorThe level of access granted to a Box Hub. Possible values are editor, viewer, and co-owner.
status
string
example: acceptedThe status of the collaboration invitation. If the status is pending, login and name return an empty string.Value is one of accepted,pending,rejected
{
  "id": "12345678",
  "type": "hub_collaboration",
  "acceptance_requirements_status": {
    "strong_password_requirement": {
      "enterprise_has_strong_password_required_for_external_users": true,
      "user_has_strong_password": true
    },
    "terms_of_service_requirement": {
      "is_accepted": true,
      "terms_of_service": {
        "id": "11446498",
        "type": "terms_of_service"
      }
    },
    "two_factor_authentication_requirement": {
      "enterprise_has_two_factor_auth_enabled": true,
      "user_has_two_factor_authentication_enabled": true
    }
  },
  "accessible_by": {
    "id": "11446498",
    "type": "user",
    "login": "[email protected]",
    "name": "Aaron Levie"
  },
  "hub": {
    "id": "12345",
    "type": "hubs"
  },
  "role": "editor",
  "status": "accepted"
}