The Databox API enables you to programmatically interact with accounts, data sources, and datasets in Databox. It is designed to integrate Databox with other systems, automate data ingestion, and extend the functionality of the platform.
The API follows standard REST conventions, using predictable, resource-oriented URLs, JSON-encoded request and response bodies, and standard HTTP verbs and status codes.
The API is available to all users on the Professional plan and above.
- Professional plan: You can create datasets and ingest data into them. However, in-app dataset functionality is limited. Features such as dataset merging, filtering, and calculated columns are not available.
- Growth and higher plans: Full dataset functionality is supported, including dataset transformations and advanced calculations.
The API is versioned, with the version number included in the URL. For example:
- Production server
https://api.databox.com/v1/accounts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.databox.com/v1/accounts \
-H 'x-api-key: YOUR_API_KEY_HERE'A changelog is available to track new features, changes, and deprecations across versions.
Each API request has an associated request identifier. You can find this value in the response body in the requestId field.
When contacting support about a specific request, include the request identifier to help us quickly locate the request and expedite the resolution process.
If you need functionality that is not currently available through the API, you can request new endpoints or features directly in our Roadmap.
- Browse the glossary for definitions of key terms used throughout the API.
- Learn how to authenticate with the API.
- Review rate limits to ensure efficient usage.
- Explore error handling to understand how errors are reported.