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

# List run groups

List run groups

# 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": "run_groups",
      "description": "Operations about run_groups"
    }
  ],
  "paths": {
    "/1/run_groups": {
      "get": {
        "summary": "List run groups",
        "description": "List run groups",
        "parameters": [
          {
            "in": "query",
            "name": "title",
            "description": "Filter by title (case-insensitive)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "sort[][title]",
            "required": false,
            "style": "form",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "asc",
                  "desc"
                ]
              }
            }
          },
          {
            "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": "Run groups retrieved",
            "headers": {
              "X-Total-Pages": {
                "description": "Total pages",
                "schema": {
                  "type": "integer"
                }
              },
              "X-Current-Page": {
                "description": "Current page",
                "schema": {
                  "type": "integer"
                }
              },
              "X-Per-Page": {
                "description": "The maximum number of results per page",
                "schema": {
                  "type": "integer"
                }
              },
              "X-Total-Results": {
                "description": "The total number of results",
                "schema": {
                  "type": "integer"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RunGroup"
                  }
                }
              }
            }
          }
        },
        "tags": [
          "run_groups"
        ],
        "operationId": "get-run_groups",
        "x-rdme-order": 1
      }
    }
  },
  "servers": [
    {
      "url": "//app.rainforestqa.com/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "CLIENT_TOKEN",
        "in": "header"
      }
    },
    "schemas": {
      "Schedule": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "repeat_rules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ScheduleRule"
            }
          },
          "timezone": {
            "type": "string"
          }
        }
      },
      "ScheduleRule": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "day": {
            "type": "string",
            "enum": [
              "sunday",
              "monday",
              "tuesday",
              "wednesday",
              "thursday",
              "friday",
              "saturday"
            ]
          },
          "time": {
            "type": "string"
          }
        }
      },
      "Connection": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "name": {
            "type": "string"
          },
          "api_token": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "link_state": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "rainforest",
              "user"
            ]
          }
        },
        "description": "Connection model"
      },
      "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"
        ]
      },
      "RunGroup": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "title": {
            "type": "string"
          },
          "reroute_geo": {
            "type": "string",
            "description": "Deprecated: please use `connection.id` instead"
          },
          "connection": {
            "$ref": "#/components/schemas/Connection"
          },
          "crowd": {
            "type": "string",
            "enum": [
              "default",
              "on_premise_crowd",
              "automation",
              "automation_and_crowd"
            ]
          },
          "execution_method": {
            "type": "string",
            "enum": [
              "crowd",
              "automation",
              "automation_and_crowd",
              "on_premise"
            ]
          },
          "browsers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "schedule": {
            "$ref": "#/components/schemas/Schedule"
          },
          "environment": {
            "$ref": "#/components/schemas/Environment"
          },
          "test_count": {
            "type": "integer",
            "format": "int32"
          }
        },
        "description": "RunGroup model"
      }
    }
  }
}
```