Manage Applications

    Get folder collaborations

    get
    https://api.box.com/2.0
    /folders/:folder_id/collaborations

    Retrieves a list of collaborations for a folder. This returns all the users that have access to the folder.

    Request

    application/json

    Path Parameters

    stringin pathrequired
    0

    The unique identifier that represent a folder.

    The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the url https://*.app.box.com/folder/123 the folder_id is 123.

    The root folder of a Box account is always represented by the ID 0.

    Query Parameters

    string arrayin queryoptional
    id,type,name

    A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

    Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

    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 on this folder 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/folders/4353455/collaborations \
         -H "Authorization: Bearer <ACCESS_TOKEN>"
    .NET
    string folderId = "11111";
    BoxCollection<BoxCollaboration> collaborations = await client.FoldersManager
        .GetCollaborationsAsync(folderId);
    Java
    BoxFolder folder = new BoxFolder(api, "id");
    Collection<BoxCollaboration.Info> collaborations = folder.getCollaborations();
    Python
    collaborations = client.folder(folder_id='22222').get_collaborations()
    for collab in collaborations:
        target = collab.accessible_by
        print('{0} {1} is collaborated on the folder'.format(target.type.capitalize(), target.name))
    Node
    var folderID = '12345';
    client.folders.getCollaborations(folderID)
    	.then(collaborations => {
    		/* collaborations -> {
    			total_count: 1,
    			entries: [
    				{
    					type: 'collaboration',
    					id: '11111',
    					created_by: {
    						type: 'user',
    						id: '22222',
    						name: 'Example User',
    						login: 'user@example.com'
    					},
    					created_at: '2011-11-29T12:56:35-08:00',
    					modified_at: '2012-09-11T15:12:32-07:00',
    					expires_at: null,
    					status: 'accepted',
    					accessible_by: {
    						type: 'user',
    						id: '33333',
    						name: 'Collaborator User',
    						login: 'collaborator@example.com'
    					},
    					role: 'editor',
    					acknowledged_at: '2011-11-29T12:59:40-08:00',
    					item: null
    				}
    			]
    		}
    		*/
    	});

    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
            }
          }
        }
      ]
    }