BObox
Collaborations

Get collaboration

Changed on

Retrieves a single collaboration.

get/collaborations/{collaboration_id}

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/collaborations/{collaboration_id}
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Path parameters

collaboration_idstring required

The ID of the collaboration.

Query parameters

fieldsstring[]

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

Returns a collaboration object.

idstring required

The unique identifier for this collaboration.

type'collaboration' required

The value will always be collaboration.

invite_emailstring nullable

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

role'editor' | 'viewer' | 'previewer' | 'uploader' | 'previewer uploader' | 'viewer uploader' | 'co-owner' | 'owner'

The level of access granted.

expires_atstring date-time nullable

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

is_access_onlyboolean

If set to true, collaborators have access to shared items, but such items won't be visible in the All Files list. Additionally, collaborators won't see the path to the root folder for the shared item.

status'accepted' | 'pending' | 'rejected'

The status of the collaboration invitation. If the status is pending, name returns an empty string.

acknowledged_atstring date-time

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

created_atstring date-time

When the collaboration object was created.

modified_atstring date-time

When the collaboration object was last modified.

Example response

{
  "id": "12345678",
  "type": "collaboration",
  "item": {
    "id": "12345",
    "etag": "1",
    "type": "file",
    "sequence_id": "3",
    "name": "Contract.pdf",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    }
  },
  "app_item": {
    "id": "12345678",
    "type": "app_item",
    "application_type": "hubs"
  },
  "accessible_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com",
    "is_active": true
  },
  "invite_email": "john@example.com",
  "role": "editor",
  "expires_at": "2012-12-26T10:53:43-08:00",
  "is_access_only": true,
  "status": "accepted",
  "acknowledged_at": "2012-12-12T10:55:20-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com",
    "is_active": true
  },
  "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
    }
  }
}

Changes

  • c4d5303fa5c3Revision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • info

      removed from the / response property oneOf list for the response status