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

# List generators

List generators

# 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": "generators",
      "description": "Operations about generators"
    }
  ],
  "paths": {
    "/1/generators": {
      "get": {
        "summary": "List generators",
        "description": "List generators",
        "parameters": [
          {
            "in": "query",
            "name": "generator_type",
            "description": "Only return generators of this type",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "builtin",
                "custom",
                "tabular"
              ]
            }
          },
          {
            "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
            }
          },
          {
            "in": "query",
            "name": "slim",
            "description": "If true, returns less data in order to reduce latency and response size",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Generators 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/Generator"
                  }
                }
              }
            }
          }
        },
        "tags": [
          "generators"
        ],
        "operationId": "get-generators",
        "x-rdme-order": 1
      }
    }
  },
  "servers": [
    {
      "url": "//app.rainforestqa.com/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "CLIENT_TOKEN",
        "in": "header"
      }
    },
    "schemas": {
      "Generator": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "name": {
            "type": "string",
            "description": "Name of generator"
          },
          "description": {
            "type": "string",
            "description": "Description of generator"
          },
          "generator_type": {
            "type": "string",
            "enum": [
              "builtin",
              "custom",
              "tabular"
            ]
          },
          "single_use": {
            "type": "boolean",
            "description": "Whether this generator's rows are deleted after a single use or not"
          },
          "reusable": {
            "type": "boolean",
            "description": "Whether this generator is reusable within a run or not"
          },
          "columns": {
            "$ref": "#/components/schemas/GeneratorColumn"
          },
          "data": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Array of JSON objects representing rows of data: keys represent column names, values represent the generator values"
          },
          "row_count": {
            "type": "integer",
            "format": "int32"
          },
          "related_tests_count": {
            "type": "integer",
            "format": "int32"
          },
          "related_archived_tests_count": {
            "type": "integer",
            "format": "int32"
          },
          "related_snippets_count": {
            "type": "integer",
            "format": "int32"
          },
          "related_archived_snippets_count": {
            "type": "integer",
            "format": "int32"
          }
        },
        "description": "Generator model"
      },
      "GeneratorColumn": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}
```