List sandboxes
Your sandboxes. In an organization’s scope (the active wallet, org, or X-Boat-Org) the list also holds every sandbox that organization pays for, whoever created it; createdBy and access say whose it is and what you may do with it.
Authorizations
Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.
Headers
Same as the org query parameter. Query wins when both are set.
Query Parameters
Billing wallet for this request: an organization you belong to, by id (team_…) or by name as GET /orgs lists it (case-insensitive), or personal. Omitted, the account's active wallet applies (PATCH /orgs/active; personal until set). Two organizations sharing the name answer 409 ambiguous_org and need the id. Sandboxes and snapshots stay creator-private. On /environments routes, only this query parameter selects the organization's shared environments; the X-Boat-Org header and the active wallet do not apply there. Members read them, owners and admins change them.
Maximum items to return.
1 <= x <= 200Opaque pagination cursor returned as pageInfo.nextCursor.
Sort direction for cursor pagination.
asc, desc Comma-separated sandbox state filter, for example ready,idle,running.
Keep sandboxes whose name starts with this text, for example myapp-. The match is literal.
Keep stopped sandboxes that stopped before this ISO 8601 time. Every stop counts, auto-stops too.
true keeps sandboxes whose data retention deleted (dataExpiredAt is set). false keeps the others.
key=value. Repeat it to require several labels, for example label=session%3Dabc&label=env%3Dprod.
cost adds each sandbox's cost this calendar month (UTC), at list price.
cost Response
Sandboxes owned by the authenticated Boat user.
true
Stable success envelope discriminator added by v1.
"sandbox.list"Only with include=cost, and not for an API key limited to some sandboxes. Machine time this calendar month (UTC) of deleted sandboxes this list would otherwise show. They are not in the list, but their time was billed. Add it to the sandboxes' cost to get the full total.