Lists environments in the current workspace with pagination, sorted by created_at in descending order. Archived items are excluded by default.
Prerequisites
Endpoint and authentication are configured. See Overview and authentication.
Endpoint
GET /environments
Query parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
limit | No | int | 20 | Number of items per page, maximum 100 |
page | No | string | — | Omit on the first call; pass next_page from the previous response for subsequent calls |
include_archived | No | bool | false | Whether to include archived environments |
Request example
Response example
data (an array of Environment objects), next_page (cursor for the next page), and request_id (unique identifier for this request). Environment object fields are as follows:
Environment object fields
| Field | Type | Description |
|---|---|---|
id | string | Environment ID, format: env_<ULID> |
type | string | Fixed value environment |
name / description / scope / config / metadata | string / object | Basic environment attributes and full runtime configuration (sandbox type, pre-installed dependencies, networking policy) |
archived_at | string | null | Archive time; null when not archived |
created_at / updated_at | string | Creation / last update time, ISO 8601 |