Skip to main content
GET
List sandboxes

Authorizations

Authorization
string
header
required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Headers

X-Boat-Org
string

Same as the org query parameter. Query wins when both are set.

Query Parameters

org
string

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, snapshots, and environments stay creator-private.

limit
integer
default:100

Maximum items to return.

Required range: 1 <= x <= 200
cursor
string | null

Opaque pagination cursor returned as pageInfo.nextCursor.

sort
enum<string>
default:desc

Sort direction for cursor pagination.

Available options:
asc,
desc
state
string

Comma-separated sandbox state filter, for example ready,idle,running.

Response

Sandboxes owned by the authenticated Boat user.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "sandbox.list"
sandboxes
object[]
required
pageInfo
object