Latest version
List group collaborations
Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise's groups.
Each collaboration object has details on which files or folders the group has access to and with what role.
Request
bearer [ACCESS_TOKEN]
application/json
Path Parameters
stringin pathrequired
57645The ID of the group.
Query Parameters
integer (int64)in queryoptional
10001000The maximum number of items to return per page.
integer (int64)in queryoptional
10000The offset of the item at which to begin the response.
Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
Response
application/jsonCollaborations
Returns a collection of collaboration objects. If there are no collaborations, an empty collection will be returned.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -i -X GET "https://api.box.com/2.0/groups/57645/collaborations" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.listCollaborations.getGroupCollaborations(group.id);Python Gen
client.list_collaborations.get_group_collaborations(group.id).NET Gen
await client.ListCollaborations.GetGroupCollaborationsAsync(groupId: group.Id);Swift Gen (Beta)
try await client.listCollaborations.getGroupCollaborations(groupId: group.id)Java
BoxGroup group = new BoxGroup(api, "id");
Collection<BoxCollaboration.Info> collaborations = group.getCollaborations();Python
collaborations = client.group(group_id='11111').get_collaborations()
for collaboration in collaborations:
print(f'The group is collaborated on {collaboration.item.type} {collaboration.item.id}').NET
BoxCollection<BoxCollaboration> groupCollaborations = await client.GroupsManager
.GetCollaborationsForGroupAsync(groupId: "11111");Node
client.groups.getCollaborations('11111')
.then(collaborations => {
/* collaborations -> {
total_count: 1,
entries:
[ { type: 'collaboration',
id: '22222',
created_by:
{ type: 'user',
id: '33333',
name: 'Example User',
login: 'user@example.com' },
created_at: '2013-11-14T16:16:20-08:00',
modified_at: '2013-11-14T16:16:20-08:00',
expires_at: null,
status: 'accepted',
accessible_by:
{ type: 'group',
id: '11111',
name: 'Remote Employees' },
role: 'viewer',
acknowledged_at: '2013-11-14T16:16:20-08:00',
item:
{ type: 'folder',
id: '44444',
sequence_id: '0',
etag: '0',
name: 'Documents' } } ],
offset: 0,
limit: 100 }
*/
});iOS
let iterator = client.groups.listCollaborations(groupId: "12345")
iterator.next { results in
switch results {
case let .success(page):
for collaboration in page.entries {
print("Collaboration with ID \(collaboration.id) was retrieved")
}
case let .failure(error):
print(error)
}
}Response Example
{
"entries": [
{
"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",
"is_active": true,
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"acknowledged_at": "2012-12-12T10:55:20-08:00",
"app_item": {
"application_type": "hubs",
"id": "12345678",
"type": "app_item"
},
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": [
{
"id": 33224412
},
{
"type": "user"
},
{
"login": "dylan@example.com"
},
{
"name": "Dylan Smith"
}
],
"expires_at": "2012-12-26T10:53:43-08:00",
"id": "12345678",
"invite_email": "john@example.com",
"is_access_only": true,
"item": {
"etag": "1",
"id": "12345",
"type": "file",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
},
"name": "Contract.pdf",
"sequence_id": "3",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"content_created_at": "2012-12-12T10:53:43-08:00",
"content_modified_at": "2012-12-12T10:53:43-08:00",
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"description": "Contract for Q1 renewal",
"item_status": "active",
"modified_at": "2012-12-12T10:53:43-08:00",
"modified_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"owned_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"parent": {
"etag": "1",
"id": "12345",
"type": "folder",
"name": "Contracts",
"sequence_id": "3"
},
"path_collection": {
"entries": [
{
"etag": "1",
"id": "12345",
"type": "folder",
"name": "Contracts",
"sequence_id": "3"
}
],
"total_count": 1
},
"purged_at": "2012-12-12T10:53:43-08:00",
"shared_link": {
"access": "open",
"download_count": 3,
"download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
"effective_access": "company",
"effective_permission": "can_download",
"is_password_enabled": true,
"permissions": {
"can_download": true,
"can_edit": false,
"can_preview": true
},
"preview_count": 3,
"unshared_at": "2018-04-13T13:53:23-07:00",
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"vanity_name": "my_url",
"vanity_url": "https://acme.app.box.com/v/my_url/"
},
"size": 629644,
"trashed_at": "2012-12-12T10:53:43-08:00"
},
"modified_at": "2012-12-12T10:53:43-08:00",
"role": "editor",
"status": "accepted",
"type": "collaboration"
}
],
"limit": 1000,
"offset": 2000,
"total_count": 5000
}