Box Developer Documentation
Log in
Latest version

Get Box Hub collaboration by collaboration ID

get
https://api.box.com/2.0
/hub_collaborations/:hub_collaboration_id

Retrieves details for a Box Hub collaboration by collaboration ID.

Request

bearer [ACCESS_TOKEN]
application/json

Request Headers

stringin headerrequired

Version header.

Value is always 2025.0

Path Parameters

stringin pathrequired
1234

The ID of the hub collaboration.

Response

application/jsonBox Hub Collaboration

Returns a Box Hub collaboration object.

application/jsonClient error

Returned when the access token provided in the Authorization header is not recognized or not provided.

application/jsonClient error

Returned if the Box Hub is not found, or the user does not have access to the Box Hub.

application/jsonClient error

An unexpected client error.

get
Get Box Hub collaboration by collaboration ID
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

TypeScript Gen
await client.hubCollaborations.getHubCollaborationByIdV2025R0(
  createdCollaboration.id,
);
Python Gen
client.hub_collaborations.get_hub_collaboration_by_id_v2025_r0(created_collaboration.id)
.NET Gen
await client.HubCollaborations.GetHubCollaborationByIdV2025R0Async(hubCollaborationId: createdCollaboration.Id);
Swift Gen (Beta)
try await client.hubCollaborations.getHubCollaborationByIdV2025R0(hubCollaborationId: createdCollaboration.id)
Java Gen (Beta)
client.getHubCollaborations().getHubCollaborationByIdV2025R0(createdCollaboration.getId())

Response Example

{
  "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": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "hub": {
    "id": "12345",
    "type": "hubs"
  },
  "role": "editor",
  "status": "accepted"
}