List allowed collaboration domains

get
https://api.box.com/2.0
/collaboration_whitelist_entries/

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

Request

Bearer [ACCESS_TOKEN]
application/json

Query Parameters

integer / int64in queryoptional
10001000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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.

Response

Returns a collection of domains that are allowed for collaboration.

application/jsonClient error

An unexpected client error.

get
List allowed collaboration domains
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -X GET https://api.box.com/2.0/collaboration_whitelist_entries \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
.NET
BoxCollectionMarkerBased<BoxCollaborationWhitelistEntry> whitelistedDomains = await client.CollaborationWhitelistManager
    .GetAllCollaborationWhitelistEntriesAsync();
Java
BoxCollaborationWhitelist.getAll(api);
Python
whitelist_entries = client.collaboration_whitelist().get_entries()
for entry in whitelist_entries:
    direction = entry.direction if entry.direction != 'both' else 'bidirectional'
    print('Domain {0} is whitelisted for {1} collaboration'.format(entry.domain, direction))
Node
client.collaborationWhitelist.getAllWhitelistedDomains(callback);

Response Example

{
  "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"
    }
  ],
  "limit": 1000,
  "next_marker": 3000,
  "prev_marker": 1000
}