Box Platform API
box · Cloud
[Box Platform](https://box.dev) provides functionality to provide access to content stored within [Box](https://box.com). It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention policies.
Authentication
Sample Requests
Authorize a user by sending them through the [Box](https://box.com) website and request their permission to act on their behalf. This is the first step when authenticating a user using OAuth 2.0. To request a user's authorization to use the Box APIs on their behalf you will need to send a user to t
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/box.com/2.0.0/authorize?scope=example&state=example&client_id=example&redirect_uri=example&response_type=code"
import requests
params = {
"scope": "example",
"state": "example",
"client_id": "example",
"redirect_uri": "example",
"response_type": "code"
}
response = requests.get(
"https://api.apis.guru/v2/specs/box.com/2.0.0/authorize",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/box.com/2.0.0/authorize');
url.searchParams.set('scope', 'example');
url.searchParams.set('state', 'example');
url.searchParams.set('client_id', 'example');
url.searchParams.set('redirect_uri', 'example');
url.searchParams.set('response_type', 'code');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/box.com/2.0.0/authorize")
q := baseURL.Query()
q.Set("scope", "example")
q.Set("state", "example")
q.Set("client_id", "example")
q.Set("redirect_uri", "example")
q.Set("response_type", "code")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/box.com/2.0.0/authorize")
uri.query = URI.encode_www_form({
"scope" => "example",
"state" => "example",
"client_id" => "example",
"redirect_uri" => "example",
"response_type" => "code"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/box.com/2.0.0/authorize?" . http_build_query([
"scope" => "example",
"state" => "example",
"client_id" => "example",
"redirect_uri" => "example",
"response_type" => "code"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Returns the list domains that have been deemed safe to create collaborations for within the current enterprise.
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/box.com/2.0.0/collaboration_whitelist_entries?limit=10&marker=example"
import requests
params = {
"limit": "10",
"marker": "example"
}
response = requests.get(
"https://api.apis.guru/v2/specs/box.com/2.0.0/collaboration_whitelist_entries",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/box.com/2.0.0/collaboration_whitelist_entries');
url.searchParams.set('limit', '10');
url.searchParams.set('marker', 'example');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/box.com/2.0.0/collaboration_whitelist_entries")
q := baseURL.Query()
q.Set("limit", "10")
q.Set("marker", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/box.com/2.0.0/collaboration_whitelist_entries")
uri.query = URI.encode_www_form({
"limit" => "10",
"marker" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/box.com/2.0.0/collaboration_whitelist_entries?" . http_build_query([
"limit" => "10",
"marker" => "example"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Returns a list of users who have been exempt from the collaboration domain restrictions.
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/box.com/2.0.0/collaboration_whitelist_exempt_targets?limit=10&marker=example"
import requests
params = {
"limit": "10",
"marker": "example"
}
response = requests.get(
"https://api.apis.guru/v2/specs/box.com/2.0.0/collaboration_whitelist_exempt_targets",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/box.com/2.0.0/collaboration_whitelist_exempt_targets');
url.searchParams.set('limit', '10');
url.searchParams.set('marker', 'example');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/box.com/2.0.0/collaboration_whitelist_exempt_targets")
q := baseURL.Query()
q.Set("limit", "10")
q.Set("marker", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/box.com/2.0.0/collaboration_whitelist_exempt_targets")
uri.query = URI.encode_www_form({
"limit" => "10",
"marker" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/box.com/2.0.0/collaboration_whitelist_exempt_targets?" . http_build_query([
"limit" => "10",
"marker" => "example"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Postman Setup Guide
- See official documentation for authentication and setup.
What can you build with Box Platform API?
Box Platform API is a Cloud API. Developers commonly use cloud APIs for:
- provisioning and managing cloud infrastructure
- automating deployments and container orchestration
- monitoring uptime and performance metrics
- managing storage buckets and databases
- setting up auto-scaling and load balancing
No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Box Platform API is free to use, making it a low-risk choice to experiment with.
New to APIs? Read our beginner's guide · Learn about API keys · What is REST?