Find Terms for Collaboration

Guides Security Terms of Service Find Terms for Collaboration

Find Terms for Collaboration

Information about the Terms of Service that is in effect for any Collaboration can be inspected by calling the GET /collaborations/:id API and passing the query parameter fields=acceptance_requirements_status.

cURL

curl -X GET https://api.box.com/2.0/collaborations/2342342?fields=acceptance_requirements_status \
    -H "authorization: Bearer <ACCESS_TOKEN>"

The resulting response will include a new acceptance_requirements object that includes a mini terms_of_service object.

{
  "type": "collaboration",
  "id": 2342342>,
  "acceptance_requirements": {
    "terms_of_service": {
      "type": "terms_of_service",
      "id": 6766677
    }
  }
}

This information is only returned if the Terms of Service for external users is enabled for the enterprise, and the user making the request has the permission to see the Terms of Service. This holds true for both admin and end users, even though admins can generally view Terms of User information via the API even if the specific Terms of Service type is turned off.

If the Terms of Service type is not enabled, the API will return an empty result.

{
  "type": "collaboration",
  "id": 2342342>,
  "acceptance_requirements": {
    "terms_of_service": null
  }
}

The terms_of_service information is returned within the acceptance_requirements even if they have already been accepted by the user.