GET /v2/sandboxes
Retrieves a paginated list of named sandboxes belonging to a specific project. Results can be sorted by creation time or name, and optionally filtered by name prefix.
Servers
- https://api.vercel.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
sortOrder |
String | No |
Sort direction. Defaults to desc. Valid values:
Default value: "desc" |
teamId |
String | No |
The Team identifier to perform the request on behalf of. |
limit |
Number | No |
Maximum number of named sandboxes to return in the response. Used for pagination. Default value: 20 |
sortBy |
String | No |
Field to sort by. Valid values:
Default value: "createdAt" |
slug |
String | No |
The Team slug to perform the request on behalf of. |
tags |
No |
Filter sandboxes by tag. Format: "key:value". Only one tag filter is supported at a time. |
|
namePrefix |
String | No |
Filter named sandboxes whose name starts with this prefix. Only valid when sortBy=name. |
cursor |
String | No |
Opaque pagination cursor from a previous response. |
project |
String | No |
The unique identifier or name of the project to list named sandboxes for. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.