BObox
Domain restrictions for collaborations

List allowed collaboration domains

Changed on

Returns the list domains that have been deemed safe to create collaborations for within the current enterprise.

get/collaboration_whitelist_entries

Request

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

Query parameters

markerstring

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

limitinteger

The maximum number of items to return per page.

Response

Returns a collection of domains that are allowed for collaboration.

limitinteger

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

next_markerstring nullable

The marker for the start of the next page of results.

prev_markerstring nullable

The marker for the start of the previous page of results.

Example response

{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "id": "11446498",
      "type": "collaboration_whitelist_entry",
      "domain": "example.com",
      "direction": "both",
      "enterprise": {
        "id": "11446498",
        "type": "enterprise",
        "name": "Acme Inc."
      },
      "created_at": "2012-12-12T10:53:43-08:00"
    }
  ]
}

Changes

  • c4d5303fa5c3Revision changes
    • warning

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

    • info

      added subschema #1 subschema #2 to the response body allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body allOf list for the response status