;
};
export const Link = ({href, children, className, ...props}) => {
const localizedHref = href;
return
{children}
;
};
Box Hub collaborations control who can access a hub and at what role. You can invite users or groups by user ID, group ID, or email (for users). Roles are `editor`, `viewer`, and `co-owner`. You can only invite users who have a Box account (any plan) to collaborate on a hub.
Box Hubs endpoints require the `box-version: 2025.0 header`. If you omit this header, the API returns a 400 error with the message `Missing required box-version header. Supported API versions: [2025.0].` For more information, see [Box API versioning strategy](/guides/api-calls/api-versioning-strategy/).
## Create a hub collaboration
To add a user or group to a hub, call the `POST /2.0/hub_collaborations` endpoint and provide:
* The hub reference (`HUB_ID`)
* The collaborator's ID and type in the `accessible_by` field
* The level of access granted to a hub in the `role` field
### Create by user ID
```sh cURL theme={null}
curl -i -X POST "https://api.box.com/2.0/hub_collaborations" \
-H "Authorization: Bearer " \
-H "box-version: 2025.0" \
-H "Content-Type: application/json" \
-d '{
"hub": {
"type": "hubs",
"id": "HUB_ID"
},
"accessible_by": {
"type": "user",
"id": "USER_ID"
},
"role": "viewer"
}'
```
```typescript Node/TypeScript v10 theme={null}
await client.hubCollaborations.createHubCollaborationV2025R0({
hub: new HubCollaborationCreateRequestV2025R0HubField({ id: hub.id }),
accessibleBy: {
type: 'user',
id: user.id,
} satisfies HubCollaborationCreateRequestV2025R0AccessibleByField,
role: 'viewer',
} satisfies HubCollaborationCreateRequestV2025R0);
```
```python Python v10 theme={null}
client.hub_collaborations.create_hub_collaboration_v2025_r0(
CreateHubCollaborationV2025R0Hub(id=hub.id),
CreateHubCollaborationV2025R0AccessibleBy(type="user", id=user.id),
"viewer",
)
```
```csharp .NET v10 theme={null}
await client.HubCollaborations.CreateHubCollaborationV2025R0Async(requestBody: new HubCollaborationCreateRequestV2025R0(hub: new HubCollaborationCreateRequestV2025R0HubField(id: hub.Id), accessibleBy: new HubCollaborationCreateRequestV2025R0AccessibleByField(type: "user") { Id = user.Id }, role: "viewer"));
```
```swift Swift v10 theme={null}
try await client.hubCollaborations.createHubCollaborationV2025R0(requestBody: HubCollaborationCreateRequestV2025R0(hub: HubCollaborationCreateRequestV2025R0HubField(id: hub.id), accessibleBy: HubCollaborationCreateRequestV2025R0AccessibleByField(type: "user", id: user.id), role: "viewer"))
```
```java Java v10 theme={null}
client.getHubCollaborations().createHubCollaborationV2025R0(new HubCollaborationCreateRequestV2025R0(new HubCollaborationCreateRequestV2025R0HubField(hub.getId()), new HubCollaborationCreateRequestV2025R0AccessibleByField.Builder("user").id(user.getId()).build(), "viewer"));
```
### Create by user email (login)
```sh cURL theme={null}
curl -i -X POST "https://api.box.com/2.0/hub_collaborations" \
-H "Authorization: Bearer " \
-H "box-version: 2025.0" \
-H "Content-Type: application/json" \
-d '{
"hub": {
"type": "hubs",
"id": "HUB_ID"
},
"accessible_by": {
"type": "user",
"login": "john@example.com"
},
"role": "editor"
}'
```
```python Python v10 theme={null}
client.hub_collaborations.create_hub_collaboration_v2025_r0(
CreateHubCollaborationV2025R0Hub(id=hub.id),
CreateHubCollaborationV2025R0AccessibleBy(type="user", login="john@example.com"),
"editor",
)
```
Replace `HUB_ID`, `USER_ID`, and the email with real values. Valid `role` values are `editor`, `viewer`, and `co-owner`. A successful response returns the new Hub collaboration object.
## List hub collaborations
To list all collaborations for a hub, call the `GET /2.0/hub_collaborations` endpoint with the hub ID.
```sh cURL theme={null}
curl -i -X GET "https://api.box.com/2.0/hub_collaborations?hub_id=HUB_ID" \
-H "Authorization: Bearer " \
-H "box-version: 2025.0"
```
```typescript Node/TypeScript v10 theme={null}
await client.hubCollaborations.getHubCollaborationsV2025R0({
hubId: hub.id,
} satisfies GetHubCollaborationsV2025R0QueryParams);
```
```python Python v10 theme={null}
client.hub_collaborations.get_hub_collaborations_v2025_r0(hub.id)
```
```csharp .NET v10 theme={null}
await client.HubCollaborations.GetHubCollaborationsV2025R0Async(queryParams: new GetHubCollaborationsV2025R0QueryParams(hubId: hub.Id));
```
```swift Swift v10 theme={null}
try await client.hubCollaborations.getHubCollaborationsV2025R0(queryParams: GetHubCollaborationsV2025R0QueryParams(hubId: hub.id))
```
```java Java v10 theme={null}
client.getHubCollaborations().getHubCollaborationsV2025R0(new GetHubCollaborationsV2025R0QueryParams(hub.getId()));
```
Optional query parameters: `marker` and `limit`. For details, see [Marker-based pagination](/guides/api-calls/pagination/marker-based).
## Get a hub collaboration by ID
To retrieve a single hub collaboration, call the `GET /2.0/hub_collaborations/{hub_collaboration_id}` endpoint with the collaboration ID.
```sh cURL theme={null}
curl -i -X GET "https://api.box.com/2.0/hub_collaborations/HUB_COLLABORATION_ID" \
-H "Authorization: Bearer " \
-H "box-version: 2025.0"
```
```typescript Node/TypeScript v10 theme={null}
await client.hubCollaborations.getHubCollaborationByIdV2025R0(hubCollaborationId);
```
```python Python v10 theme={null}
client.hub_collaborations.get_hub_collaboration_by_id_v2025_r0(hub_collaboration_id)
```
```csharp .NET v10 theme={null}
await client.HubCollaborations.GetHubCollaborationByIdV2025R0Async(hubCollaborationId: hubCollaborationId);
```
```java Java v10 theme={null}
client.getHubCollaborations().getHubCollaborationByIdV2025R0(hubCollaborationId);
```
## Update a hub collaboration
To change a collaborator's role, call the `PUT /2.0/hub_collaborations/{hub_collaboration_id}` endpoint with the hub collaboration ID and the new `role`.
```sh cURL theme={null}
curl -i -X PUT "https://api.box.com/2.0/hub_collaborations/HUB_COLLABORATION_ID" \
-H "Authorization: Bearer " \
-H "box-version: 2025.0" \
-H "Content-Type: application/json" \
-d '{
"role": "editor"
}'
```
```typescript Node/TypeScript v10 theme={null}
await client.hubCollaborations.updateHubCollaborationByIdV2025R0(hubCollaborationId, {
role: 'editor',
} satisfies HubCollaborationUpdateRequestV2025R0);
```
```python Python v10 theme={null}
client.hub_collaborations.update_hub_collaboration_by_id_v2025_r0(hub_collaboration_id, role="editor")
```
```csharp .NET v10 theme={null}
await client.HubCollaborations.UpdateHubCollaborationByIdV2025R0Async(hubCollaborationId: hubCollaborationId, requestBody: new HubCollaborationUpdateRequestV2025R0() { Role = "editor" });
```
```java Java v10 theme={null}
client.getHubCollaborations().updateHubCollaborationByIdV2025R0(hubCollaborationId, new HubCollaborationUpdateRequestV2025R0.Builder().role("editor").build());
```
## Delete a hub collaboration
To remove a collaborator from a hub, call the `DELETE /2.0/hub_collaborations/{hub_collaboration_id}` endpoint with the hub collaboration ID.
```sh cURL theme={null}
curl -i -X DELETE "https://api.box.com/2.0/hub_collaborations/HUB_COLLABORATION_ID" \
-H "Authorization: Bearer " \
-H "box-version: 2025.0"
```
```typescript Node/TypeScript v10 theme={null}
await client.hubCollaborations.deleteHubCollaborationByIdV2025R0(hubCollaborationId);
```
```python Python v10 theme={null}
client.hub_collaborations.delete_hub_collaboration_by_id_v2025_r0(hub_collaboration_id)
```
```csharp .NET v10 theme={null}
await client.HubCollaborations.DeleteHubCollaborationByIdV2025R0Async(hubCollaborationId: hubCollaborationId);
```
```java Java v10 theme={null}
client.getHubCollaborations().deleteHubCollaborationByIdV2025R0(hubCollaborationId);
```
A successful delete returns no body (HTTP 204).
## Use cases
* **Onboarding automation:** When a new hire is added to your HRIS, create a "Welcome Hub" and add them as a collaborator with the appropriate role.
* **Group-based access:** Use the Box Groups API to find the right group, then add the group as a collaborator so all members get access.