Skip to navigation
API referenceSandbox

Read the sandbox workspace

View as Markdown

Authentication

AuthorizationBearer

Your Truvo API key, sent as a bearer token. The prefix selects sandbox (trv_sandbox_) or live (trv_live_).

Response headers

Request-Idstringformat: "^req_[0-9a-f]{16}$"

The ID of this answer. An error body repeats it as request_id.

RateLimit-LimitintegerOptional
The calls this window allows, for the limit you're closest to reaching. The window is one minute, or one UTC day for a daily sandbox limit. A fixed window allows a burst of up to twice the limit across a window edge.
RateLimit-RemainingintegerOptional
The calls left in the current window.
RateLimit-ResetintegerOptional
Seconds until the current window ends and the count resets.

Response

The sandbox workspace for this key.
partner_idstring>=1 character
environment"sandbox"
active_scenariostring or null
clock_offset_secondsinteger0-9007199254740991
workspace_timedatetime
quotes_expired_atdatetime or null
reset_countinteger0-9007199254740991
scenario_catalog_versionstring>=1 character

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error