Box Developer Documentation
Log in
Latest version

List allowed collaboration domains

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

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

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

Related Guides

Request

bearer [ACCESS_TOKEN]
application/json

Query Parameters

integer (int64)in queryoptional
1000
1000

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

application/jsonAllowed collaboration domains

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

Learn more about Box SDK versioning strategy.


cURL
curl -i -X GET "https://api.box.com/2.0/collaboration_whitelist_entries" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.collaborationAllowlistEntries.getCollaborationWhitelistEntries();
Python v10
client.collaboration_allowlist_entries.get_collaboration_whitelist_entries()
.NET v10
await client.CollaborationAllowlistEntries.GetCollaborationWhitelistEntriesAsync();
Swift v10
try await client.collaborationAllowlistEntries.getCollaborationWhitelistEntries()
Java v10
client.getCollaborationAllowlistEntries().getCollaborationWhitelistEntries()
.NET v6
BoxCollectionMarkerBased<BoxCollaborationWhitelistEntry> whitelistedDomains = await client.CollaborationWhitelistManager
    .GetAllCollaborationWhitelistEntriesAsync();
Node v4
client.collaborationAllowlist.getAllAllowlistedDomains(callback);

Response Example

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