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.

Related Guides

Collaborations List allowed domains for collaboration

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Query Parameters

limit integer / int64in queryoptional

example1000max1000

The maximum number of items to return per page.

marker stringin queryoptional

example"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

200application/jsonAllowed collaboration domains

Returns a collection of domains that are allowed for collaboration.

defaultapplication/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.

Request Example

cURL

curl -i -X GET "https://api.box.com/2.0/collaboration_whitelist_entries" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

.NET

BoxCollectionMarkerBased<BoxCollaborationWhitelistEntry> whitelistedDomains = await client.CollaborationWhitelistManager
    .GetAllCollaborationWhitelistEntriesAsync();

Node

client.collaborationAllowlist.getAllAllowlistedDomains(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": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}