Core Box API covering types and formats for requests, responses, pagination, and error handling.
Field note
The Box API uses JSON for requests and responses, with exceptions for OAuth and uploads. It supports RFC 3339 timestamps, gzip compression, and provides standardized resource and collection formats.
Capabilities
Tags
Ways to use it
No integrations filed yet.
Product features
Include this header to suppress email and webhook notifications for supported API calls.
Supports uploading large files in chunks.
Generate developer tokens for quick testing.
Use the direction query parameter with values ASC or DESC to set sorting direction.
ETag value returned in file system item responses.
Append fields query parameter to request specific fields not returned by default.
Uses API and content delivery domains for authenticated and public downloads.
Requires access to Box CDN domains for JavaScript and content.
Uses API and dedicated upload domains.
Total set of fields when requesting with fields parameter.
Documentation of HTTP status code ranges (2xx, 3xx, 4xx, 5xx) used by the Box API.
Header to ensure consistent changes.
Header to prevent unnecessary downloads.
Reduced set of essential fields for nested resources.
Uses OAuth 2.0 for authentication.
Admins and co-admins can access the Platform Insights dashboard that provides information on the total number of API calls per application.
JSON request bodies with exceptions for OAuth and uploads.
JSON responses with exceptions for deletions and binary downloads.
The Box API is a RESTful API that follows common HTTP standards where possible.
Use the sort query parameter to define the field to sort on.
Default set of fields returned in an API response.
Supports RFC 3339 timestamps with optional millisecond precision.