Box Developer Documentation

Join BoxWorks 2024 to discover what's possible with content and AI!

Register now!

List group collaborations

get
https://api.box.com/2.0
/groups/:group_id/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
57645

The ID of the group.

Query Parameters

integer (int64)in queryoptional
10001000

The maximum number of items to return per page.

integer (int64)in queryoptional
10000

The 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.

get
List group collaborations
You can now try out some of our APIs live, right here in the documentation.
Log in

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": [
    {
      "id": "12345678",
      "type": "collaboration",
      "item": {
        "id": "12345",
        "etag": "1",
        "type": "file",
        "sequence_id": "3",
        "name": "Contract.pdf",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
        "file_version": {
          "id": "12345",
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        },
        "description": "Contract for Q1 renewal",
        "size": 629644,
        "path_collection": {
          "total_count": 1,
          "entries": [
            {
              "id": "12345",
              "etag": "1",
              "type": "folder",
              "sequence_id": "3",
              "name": "Contracts"
            }
          ]
        },
        "created_at": "2012-12-12T10:53:43-08:00",
        "modified_at": "2012-12-12T10:53:43-08:00",
        "trashed_at": "2012-12-12T10:53:43-08:00",
        "purged_at": "2012-12-12T10:53:43-08:00",
        "content_created_at": "2012-12-12T10:53:43-08:00",
        "content_modified_at": "2012-12-12T10:53:43-08:00",
        "created_by": {
          "id": "11446498",
          "type": "user",
          "name": "Aaron Levie",
          "login": "ceo@example.com"
        },
        "modified_by": {
          "id": "11446498",
          "type": "user",
          "name": "Aaron Levie",
          "login": "ceo@example.com"
        },
        "owned_by": {
          "id": "11446498",
          "type": "user",
          "name": "Aaron Levie",
          "login": "ceo@example.com"
        },
        "shared_link": {
          "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
          "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
          "vanity_url": "https://acme.app.box.com/v/my_url/",
          "vanity_name": "my_url",
          "access": "open",
          "effective_access": "company",
          "effective_permission": "can_download",
          "unshared_at": "2018-04-13T13:53:23-07:00",
          "is_password_enabled": true,
          "permissions": {
            "can_download": true,
            "can_preview": true,
            "can_edit": false
          },
          "download_count": 3,
          "preview_count": 3
        },
        "parent": {
          "id": "12345",
          "etag": "1",
          "type": "folder",
          "sequence_id": "3",
          "name": "Contracts"
        },
        "item_status": "active"
      },
      "app_item": {
        "id": "12345678",
        "type": "app_item",
        "application_type": "hubs"
      },
      "accessible_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com",
        "is_active": true
      },
      "invite_email": "john@example.com",
      "role": "editor",
      "expires_at": "2012-12-26T10:53:43-08:00",
      "is_access_only": true,
      "status": "accepted",
      "acknowledged_at": "2012-12-12T10:55:20-08:00",
      "created_by": [
        {
          "id": 33224412
        },
        {
          "type": "user"
        },
        {
          "login": "dylan@example.com"
        },
        {
          "name": "Dylan Smith"
        }
      ],
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "acceptance_requirements_status": {
        "terms_of_service_requirement": {
          "is_accepted": true,
          "terms_of_service": {
            "id": "11446498",
            "type": "terms_of_service"
          }
        },
        "strong_password_requirement": {
          "enterprise_has_strong_password_required_for_external_users": true,
          "user_has_strong_password": true
        },
        "two_factor_authentication_requirement": {
          "enterprise_has_two_factor_auth_enabled": true,
          "user_has_two_factor_authentication_enabled": true
        }
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "offset": 2000,
  "order": [
    {
      "by": "type",
      "direction": "ASC"
    }
  ],
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "total_count": 5000
}