---
updatedAt: 2026-04-21T03:46:21.000Z
agentTools:
projectIndex: https://help.rainforestqa.com/llms.txt
---
# List runs
List runs
# 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.
Find your API Token (for the CLIENT_TOKEN header field) on the integration settings page.",
"version": "1"
},
"security": [
{
"api_key": []
}
],
"tags": [
{
"name": "runs",
"description": "Operations about runs"
}
],
"paths": {
"/1/runs": {
"get": {
"summary": "List runs",
"description": "List runs",
"parameters": [
{
"in": "query",
"name": "created_at[gte]",
"description": "Only runs created at or after this time; must be used with `created_at[lt]`",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "created_at[lt]",
"description": "Only runs created before this time; must be used with `created_at[gte]`",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "execution_method",
"description": "Only runs executed using this method",
"required": false,
"schema": {
"type": "string",
"enum": [
"crowd",
"automation",
"automation_and_crowd",
"on_premise"
]
}
},
{
"in": "query",
"name": "crowd",
"description": "Only runs against this crowd",
"required": false,
"schema": {
"type": "string",
"enum": [
"default",
"on_premise_crowd",
"automation",
"automation_and_crowd"
]
}
},
{
"in": "query",
"name": "environment_id",
"description": "Only runs against this/these environment(s)",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "mode",
"description": "Only runs with this mode",
"required": false,
"schema": {
"type": "string",
"enum": [
"standard",
"draft",
"rerun"
]
}
},
{
"in": "query",
"name": "query",
"description": "Only runs that have an id that matches this query or runs that have a description which contains the query",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "release",
"description": "Only runs matching this release",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "result",
"description": "Only runs with this result",
"required": false,
"schema": {
"type": "string",
"enum": [
"passed",
"failed",
"no_result"
]
}
},
{
"in": "query",
"name": "run_group_id",
"description": "Only runs for this/these run group(s)",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "source",
"description": "Only runs from this source",
"required": false,
"schema": {
"type": "string",
"enum": [
"api",
"application",
"rainforest-cli",
"rainforest-orb",
"rainforest-gh-action",
"schedule",
"unknown"
]
}
},
{
"in": "query",
"name": "state",
"description": "Only runs in this state",
"required": false,
"schema": {
"type": "string",
"enum": [
"queued",
"validating",
"downloading_app",
"waiting_for_test_initialization",
"analyzing_app",
"error",
"sending_webhook",
"in_progress",
"aborting",
"aborted",
"timed_out",
"waiting_for_callback",
"complete",
"pending_investigation"
]
}
},
{
"in": "query",
"name": "user_id",
"description": "Only runs created by this/these user(s)",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "branch_id",
"description": "Only runs created on this/these branch(es)",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "sort[][id]",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
},
{
"in": "query",
"name": "sort[][description]",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
},
{
"in": "query",
"name": "sort[][created_at]",
"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": "Runs 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/Runs_Index"
}
}
}
}
},
"400": {
"description": "Could not list runs using provided parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"runs"
],
"operationId": "get-runs",
"x-rdme-order": 1
}
}
},
"servers": [
{
"url": "//app.rainforestqa.com/api"
}
],
"components": {
"securitySchemes": {
"api_key": {
"type": "apiKey",
"name": "CLIENT_TOKEN",
"in": "header"
}
},
"schemas": {
"UserLite": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"state": {
"type": "string"
},
"role": {
"type": "string"
}
}
},
"Error": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "An error message describing what went wrong"
}
},
"required": [
"error"
],
"description": "Error model"
},
"RunProgress": {
"type": "object",
"properties": {
"percent": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"complete": {
"type": "integer",
"format": "int32"
},
"passed": {
"type": "integer",
"format": "int32"
},
"failed": {
"type": "integer",
"format": "int32"
},
"no_result": {
"type": "integer",
"format": "int32"
},
"eta": {
"type": "object"
}
}
},
"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"
]
},
"Runs_Index": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"crowd": {
"type": "string",
"enum": [
"default",
"on_premise_crowd",
"automation",
"automation_and_crowd"
]
},
"execution_method": {
"type": "string",
"enum": [
"crowd",
"automation",
"automation_and_crowd",
"on_premise"
]
},
"environment": {
"$ref": "#/components/schemas/Environment"
},
"branch_id": {
"type": "integer",
"format": "int32"
},
"environment_id": {
"type": "integer",
"format": "int32"
},
"state": {
"type": "string",
"enum": [
"queued",
"validating",
"downloading_app",
"waiting_for_test_initialization",
"analyzing_app",
"error",
"sending_webhook",
"in_progress",
"aborting",
"aborted",
"timed_out",
"waiting_for_callback",
"complete",
"pending_investigation"
]
},
"mode": {
"type": "string",
"enum": [
"standard",
"draft"
]
},
"description": {
"type": "string"
},
"state_details": {
"type": "object"
},
"has_webhook": {
"type": "boolean"
},
"result": {
"type": "string",
"enum": [
"passed",
"failed",
"no_result"
]
},
"current_progress": {
"$ref": "#/components/schemas/RunProgress"
},
"timestamps": {
"type": "object"
},
"release": {
"type": "string"
},
"browsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RunBrowser"
}
},
"user": {
"$ref": "#/components/schemas/UserLite"
},
"user_id": {
"type": "integer",
"format": "int32"
},
"requested_tests": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"error_reason": {
"type": "string"
},
"app_logs": {
"type": "array",
"items": {
"type": "string",
"format": "url"
}
},
"filters": {
"type": "object"
},
"source": {
"type": "string",
"enum": [
"api",
"application",
"rainforest-cli",
"rainforest-orb",
"rainforest-gh-action",
"schedule",
"unknown"
]
},
"frontend_url": {
"type": "string",
"format": "url"
},
"total_tests": {
"type": "integer",
"format": "int32"
},
"total_passed_tests": {
"type": "integer",
"format": "int32"
},
"total_failed_tests": {
"type": "integer",
"format": "int32"
},
"total_no_result_tests": {
"type": "integer",
"format": "int32"
},
"total_rescued_tests": {
"type": "string"
},
"total_self_healed_tests": {
"type": "string"
},
"total_failures_categorized": {
"type": "integer",
"format": "int32"
},
"total_failures_resolved": {
"type": "integer",
"format": "int32"
},
"time_taken": {
"type": "number"
}
},
"description": "Runs_Index model"
},
"RunBrowser": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"category": {
"type": "string",
"enum": [
"browser",
"software",
"tablet",
"phone"
]
},
"state": {
"type": "string",
"enum": [
"enabled",
"disabled"
]
}
}
}
}
}
}
```