Box Developer Documentation
Log in

Collaboration

Collaborations define access permissions for users and groups to files and folders, similar to access control lists. A collaboration object grants a user or group access to a file or folder with permissions defined by a specific role.

object
object
boolean
true

Whether or not the enterprise that owns the content requires a strong password to collaborate on the content.

boolean
true

Whether or not the user has a strong password set for their account. The field is null when a strong password is not required.

object
boolean
true

Whether or not the terms of service have been accepted. The field is null when there is no terms of service required.

Terms of service (Mini) object

The terms of service that must be accepted before the collaboration can be accepted. The field is null when there is no terms of service required.

object
boolean
true

Whether or not the enterprise that owns the content requires two-factor authentication to be enabled in order to collaborate on the content.

boolean
true

Whether or not the user has two-factor authentication enabled. The field is null when two-factor authentication is not required.

User (Mini) object

The user or group that is granted access

string / date-time
2012-12-12T10:53:43-08:00

When the status of the collaboration object changed to accepted or rejected

string / date-time
2012-12-12T10:53:43-08:00

When the collaboration object was created

User (Mini) object

The user who created the collaboration object

string / date-time
2012-12-12T10:53:43-08:00

When the collaboration will expire, or null if no expiration date is set.

string
11446498

The unique identifier for this object

string
john@example.com

The email address used to invite an unregistered collaborator, if they are not a registered user.

Item (Mini) object

The file or folder to which access is granted. The field is null when the collaboration status is pending.

string / date-time
2012-12-12T10:53:43-08:00

When the collaboration object was last modified

string
editor

The level of access granted.

Value is one of editor,viewer,previewer,uploader,previewer uploader,viewer uploader,co-owner,owner

string
accepted

The status of the collaboration invitation.

Value is one of accepted,pending,rejected

string
collaboration

Value is always collaboration

Response Example

{
  "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,
    "login": "ceo@example.com",
    "name": "Aaron Levie",
    "type": "user"
  },
  "acknowledged_at": "2012-12-12T10:53:43-08:00",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": 11446498,
    "login": "ceo@example.com",
    "name": "Aaron Levie",
    "type": "user"
  },
  "expires_at": "2012-12-12T10:53:43-08:00",
  "id": 11446498,
  "invite_email": "john@example.com",
  "item": {
    "etag": 1,
    "id": 11446498,
    "name": "Pictures",
    "sequence_id": 3,
    "type": "file"
  },
  "modified_at": "2012-12-12T10:53:43-08:00",
  "role": "editor",
  "status": "accepted",
  "type": "collaboration"
}