Skip to main content
GET
List sandboxes

Authorizations

Authorization
string
header
required

A team API key, sk_offstage_…, created in the console. Everything it touches belongs to its team.

Query Parameters

state
enum<string>

Only sandboxes in this state.

Available options:
pending,
ready,
closed
limit
integer
default:50

Page size.

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

The previous page's nextCursor. It marks a position among all your items, so an item that leaves the state filter between pages never breaks the listing.

Response

A page of sandboxes.

sandboxes
object[]
required
nextCursor
string | null
required

Pass as cursor for the next page; null on the last page.