Manage Applications

    List group's 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

    application/json

    Path Parameters

    stringin pathrequired
    57645

    The ID of the group.

    Query Parameters

    integer / int64in queryoptional
    10001000-1000

    The maximum number of items to return per page.

    integer / int64in queryoptional
    10000

    The offset of the item at which to begin the response.

    Response

    application/jsonCollaborations

    Returns a collection of collaboration objects. If there are no collaborations, an empty collection will be returned.

    You can now try out some of our APIs live, right here in the documentation.
    Log In

    Request Example

    cURL
    curl -X GET https://api.box.com/2.0/groups/57645/collaborations \
         -H "Authorization: Bearer <ACCESS_TOKEN>"
    .NET
    BoxCollection<BoxCollaboration> groupCollaborations = await client.GroupsManager
        .GetCollaborationsForGroupAsync(groupId: "11111");
    Java
    BoxGroup group = new BoxGroup(api, "id");
    group.getCollaborations();
    Python
    collaborations = client.group(group_id='11111').get_collaborations()
    for collaboration in collaborations:
        print('The group is collaborated on {0} {1}'.format(collaboration.item.type, collaboration.item.id))
    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 }
    		*/
    	});

    Response Example

    {
      "total_count": 5000,
      "limit": 1000,
      "offset": 2000,
      "order": [
        {
          "by": "type",
          "direction": "ASC"
        }
      ],
      "entries": [
        {
          "id": 11446498,
          "type": "collaboration",
          "item": {
            "id": 11446498,
            "type": "file",
            "sequence_id": 3,
            "etag": 1,
            "name": "Pictures"
          },
          "accessible_by": {
            "id": 11446498,
            "type": "user",
            "name": "Aaron Levie",
            "login": "ceo@example.com"
          },
          "invite_email": "john@example.com",
          "role": "editor",
          "expires_at": "2012-12-12T10:53:43-08:00",
          "status": "accepted",
          "acknowledged_at": "2012-12-12T10:53:43-08:00",
          "created_by": {
            "id": 11446498,
            "type": "user",
            "name": "Aaron Levie",
            "login": "ceo@example.com"
          },
          "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
            }
          }
        }
      ]
    }