---
updatedAt: 2026-04-21T03:46:21.000Z
agentTools:
  projectIndex: https://help.rainforestqa.com/llms.txt
---

# List environments

List environments

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Rainforest API Documentation",
    "description": "Nearly all interactions done on in Rainforest can be done in via the API.<br/><br/>Find your API Token (for the CLIENT_TOKEN header field) on the <a href=\"https://app.rainforestqa.com/settings/integrations\">integration settings</a> page.",
    "version": "1"
  },
  "security": [
    {
      "api_key": []
    }
  ],
  "tags": [
    {
      "name": "environments",
      "description": "Operations about environments"
    }
  ],
  "paths": {
    "/1/environments": {
      "get": {
        "summary": "List environments",
        "description": "List environments",
        "parameters": [
          {
            "in": "query",
            "name": "name",
            "description": "Filter by name (case-insensitive)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "page",
            "description": "Page of results to display",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "in": "query",
            "name": "page_size",
            "description": "Number of results to return per page; maximum: 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 10
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieved environments",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Environment"
                  }
                }
              }
            }
          }
        },
        "tags": [
          "environments"
        ],
        "operationId": "get-environments",
        "x-rdme-order": 1
      }
    }
  },
  "servers": [
    {
      "url": "//app.rainforestqa.com/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "CLIENT_TOKEN",
        "in": "header"
      }
    },
    "schemas": {
      "Environment": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "name": {
            "type": "boolean"
          },
          "default": {
            "type": "boolean"
          },
          "webhook": {
            "type": "string",
            "format": "url"
          },
          "webhook_enabled": {
            "type": "boolean"
          },
          "is_temporary": {
            "type": "boolean"
          },
          "deleted_at": {
            "type": "string",
            "format": "date-time",
            "description": "Only rendered if the environment is deleted"
          },
          "site_environments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteEnvironment"
            }
          },
          "will_delete_after": {
            "type": "string",
            "format": "date-time",
            "description": "Only rendered if `is_temporary` is `true`"
          }
        },
        "required": [
          "name",
          "default",
          "webhook",
          "webhook_enabled",
          "is_temporary",
          "site_environments"
        ],
        "description": "Environment model"
      },
      "SiteEnvironment": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "site_id": {
            "type": "integer",
            "format": "int32"
          },
          "environment_id": {
            "type": "integer",
            "format": "int32"
          },
          "url": {
            "type": "string",
            "format": "url"
          }
        },
        "required": [
          "site_id",
          "environment_id",
          "url"
        ]
      }
    }
  }
}
```