Skip to main content
GET
List sandboxes

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Query Parameters

project_reference
string

Project UUID or slug whose billed sandboxes are listed. Omit it to list your private sandboxes.

access_scope
enum<string>
Available options:
project,
private
cursor
string

Cursor for pagination. Uses the sandbox ID.

limit
integer
default:20

Maximum sandboxes to return. Defaults to 20 and is capped at 100.

Required range: 1 <= x <= 100
sort_by
enum<string>
default:created_at

Sort field. Defaults to created_at.

Available options:
created_at,
status
sort_order
enum<string>
default:desc

Sort order. Defaults to desc.

Available options:
asc,
desc

Response

Paginated project sandboxes, or the caller’s private sandboxes when no project is given.

data
object[]
required
page_info
object
required