Manage Applications

    Get collaboration

    get
    https://api.box.com/2.0
    /collaborations/:collaboration_id

    Retrieves a single collaboration.

    Request

    application/json

    Path Parameters

    stringin pathrequired
    1234

    The ID of the collaboration

    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.

    Response

    application/jsonCollaboration

    Returns a collaboration object.

    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/collaborations/1234 \
         -H "Authorization: Bearer <ACCESS_TOKEN>"
    .NET
    BoxCollaboration collab = await client.CollaborationsManager.GetCollaborationAsync(id: "22222");
    Java
    BoxCollaboration collaboration = new BoxCollaboration(api, "id");
    BoxCollaboration.Info info = collaboration.getInfo();
    Python
    collaboration = client.collaboration(collab_id='12345').get()
    Node
    var collaborationID = '22222';
    client.collaborations.get(collaborationID)
    	.then(collaboration => {
    		/* collaboration -> {
    			type: 'collaboration',
    			id: '22222',
    			created_by: {
    				type: 'user',
    				id: '11111',
    				name: 'Example User',
    				login: 'user@example.com'
    			},
    			created_at: '2012-12-12T10:54:37-08:00',
    			modified_at: '2012-12-12T11:30:43-08:00',
    			expires_at: null,
    			status: 'accepted',
    			accessible_by: {
    				type: 'user',
    				id: '33333',,
    				name: 'Collaborator User',
    				login: 'collaborator@example.com'
    			},
    			role: 'editor',
    			acknowledged_at: '2012-12-12T11:30:43-08:00',
    			item: {
    				type: 'folder',
    				id: '12345',
    				sequence_id: '0',
    				etag: '0',
    				name: 'Shared Pictures'
    			}
    		}
    		*/
    	});

    Response Example

    {
      "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
        }
      }
    }