Skip to main content
GET
List sandbox scenarios

Authorizations

X-Access-Client-Id
string
header
required

Client ID

X-Access-Secret
string
header
required

Client Access Key

Query Parameters

data_source
enum<string>

Only scenarios bound to this data source.

Available options:
payroll,
docs,
financial_accounts,
education,
credit,
insurance
Example:

"payroll"

product
enum<string>

Only scenarios that would serve this product. Scenarios with no products are not pinned and so serve any product; they are always included.

Available options:
income,
employment,
deposit_switch,
pll,
insurance,
transactions,
assets,
admin,
credit,
education
Example:

"income"

enabled
boolean

Only scenarios with this enabled state.

Example:

true

cursor
string

Opaque pagination cursor, taken from the next URL of a previous page.

page_size
integer
default:10

Number of results to return per page.

Required range: x <= 100

Response

A cursor-paginated page of sandbox scenarios.

results
object[]
required

Scenarios ordered oldest first. Matching fields depend on the input being resolved and so cannot be reflected in a list; use the resolve endpoint to see the actual winner for an input.

next
string<uri> | null

Opaque URL of the next page, or null on the last page.

Example:

"https://prod.truv.com/v1/sandbox/scenarios/?cursor=cD0yMDI2LTA5LTE3"