Forward API reference.
Description
Lists Environments visible to the current account, with cursor pagination.
Path
GET /api/v1/forward/environments
Request headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Page size, maximum 100. |
page | string | No | Pagination cursor (recommended), taken from next_page in the previous response. Mutually exclusive with after_id and before_id. |
after_id | string | No | Forward pagination cursor. Mutually exclusive with page and before_id. |
before_id | string | No | Backward pagination cursor. Mutually exclusive with page and after_id. |
identity_id | string | No | Optional; used only for Identity-owned resources. PAT callers can pass it explicitly; omitting it uses the administrator scope. For SAT, issue an Identity-scoped token and do not explicitly pass this parameter, or the request returns HTTP 400. See Identity ownership. |
Example request
Example response
Empty-list response
Response fields
Each item in the response data array is an Environment object. See List pagination fields for pagination fields.
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | The request body, path parameters, or query parameters are invalid. Also returned if SAT explicitly includes identity_id. |
| 401 | authentication_error | The authentication token is missing or invalid. |
| 403 | permission_error | Owner mismatch for a PAT without identity_id or an Admin SAT, or other insufficient permissions. |
| 404 | not_found_error | identity_id is invalid, disabled, or does not belong to the caller, or the target resource does not belong to the current Identity scope. |
| 500/502/503 | api_error | Forward or a dependent service failed. |

