List whitelist entries

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

Returns the list of whitelist entries which specify what domains can collaborate with the current enterprise.

Request

application/json

Query Parameters

integer / int64in queryoptional
10001000-1000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

The position marker at which to begin the response.

This requires usemarker to be set to true.

Response

Returns a collection of collaboration whitelist entries.

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

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