Skip to main content
Sandbox APIs accept JSON payloads, query parameters, and path parameters, and return standard JSON responses.

​
Request methods

  • GET: Retrieve data using path or query parameters
  • POST: Create or submit data with JSON body
  • PUT: Update existing data with JSON body
  • DELETE: Remove data using path or query parameters
Some endpoints may have exceptions to these patterns—check the specific API reference documentation.

​
Headers

All API requests to Sandbox require specific http headers for authentication and configuration:
​
string
required
Your API key from the Sandbox ConsoleExample: key_live_SIethxxxxxxxx
​
string
required
Your JWT access token (without “Bearer” prefix)Example: eyJhbGcxxxxx.eyJhdJxxxx.Si29xxxxx
​
string
Your API secret. Required only for the Authenticate API to generate access tokensExample: secret_live_xxxxxxxxxxx
​
string
API version. Uses latest stable version if omittedExample: 1.0
​
string
Specify the data source. Defaults to primary if not specifiedExample: secondary
​
string
Set to no-cache to bypass cache and get latest dataExample: no-cache
​
string
The Content-Type of the request bodyExample: application/json

​
Request example

Here’s a complete example showing how to make an API request with all required headers:

​
Response structure

All Sandbox API responses follow a consistent JSON structure with these fields:
​
number
http status code indicating success or error
​
object
Response payload containing the requested data or error details
​
number
Unix timestamp (in milliseconds) indicating when the server generated the response
​
string
Unique identifier for tracking the request across systems

​
Special formats

​
Sheet structure

Some APIs accept data in a sheet structure format for bulk operations. The JSON body represents tabular data similar to a spreadsheet. See Sheet JSON format for details.