Latest version
Get collaboration
Retrieves a single collaboration.
Request
bearer [ACCESS_TOKEN]
application/json
Path Parameters
stringin pathrequired
1234The ID of the collaboration
Query Parameters
string arrayin queryoptional
id,type,nameA 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.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -i -X GET "https://api.box.com/2.0/collaborations/1234" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.userCollaborations.getCollaborationById(collaborationId);Python Gen
client.user_collaborations.get_collaboration_by_id(collaboration_id).NET Gen
await client.UserCollaborations.GetCollaborationByIdAsync(collaborationId: collaborationId);Swift Gen (Beta)
try await client.userCollaborations.getCollaborationById(collaborationId: collaborationId)Java
BoxCollaboration collaboration = new BoxCollaboration(api, "id");
BoxCollaboration.Info info = collaboration.getInfo();Python
collaboration = client.collaboration(collab_id='12345').get().NET
BoxCollaboration collab = await client.CollaborationsManager.GetCollaborationAsync(id: "22222");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'
}
}
*/
});iOS
client.collaborations.get(collaborationId: "12345") { (result: Result<Collaboration, BoxSDKError>) in
guard case let .success(collaboration) = result else {
print("Error retrieving collaboration")
return
}
let collaborator: String
switch collaboration.accessibleBy.collaboratorValue {
case let .user(user):
collaborator = "user \(user.name)"
case let .group(group):
collaborator = "group \(group.name)"
}
let itemName: String
switch collaboration.item {
case let .file(file):
itemName = file.name
case let .folder(folder):
itemName = folder.name
case let .webLink(webLink):
itemName = webLink.name
}
print("Collaboration \(collaboration.id) gives \(collaborator) access to \(itemName)")
}Response Example
{
"id": "12345678",
"type": "collaboration",
"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": {
"id": "12345678",
"type": "app_item",
"application_type": "hubs"
},
"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",
"invite_email": "john@example.com",
"is_access_only": true,
"item": {
"id": "12345",
"type": "file",
"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",
"etag": "1",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
},
"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"
},
"name": "Contract.pdf",
"owned_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"parent": {
"id": "12345",
"type": "folder",
"etag": "1",
"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",
"sequence_id": "3",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"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"
}