Skip to main content
GET
Returns the authenticated user’s live sandboxes. Terminated sandboxes are excluded unless you set state=TERMINATED. A terminated sandbox stays readable by ID either way. When you pass several filters, a sandbox must match all of them.

Query parameters

enum<string>
Only return sandboxes in this lifecycle state. One of CREATING, RUNNING, TERMINATED, or FAILED.
string[]
Only return sandboxes carrying every one of these labels, each written as key=value. Keys and values match exactly, with no wildcard or prefix matching. Repeat the parameter for multiple labels, for example ?labels=project=checkout&labels=env=staging.

Response

Sandbox[]
required
The matching sandboxes. See Get a sandbox for the fields of each sandbox.

Errors

Last modified on October 19, 2026