> ## Documentation Index
> Fetch the complete documentation index at: https://docs.roark.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List run groups

> Returns the run groups in the project, newest first, with their runs and where each group report stands. Read a report document from `GET /v1/simulation/run-group/{groupId}`.



## OpenAPI

````yaml /api-reference/openapi.documented.json get /v1/simulation/run-group
openapi: 3.1.0
info:
  title: Roark Analytics API
  description: >-
    The Roark Analytics API gives you access to the same API that powers the
    award winning Roark Analytics platform.
  version: 1.0.0
servers:
  - description: Production
    url: https://api.roark.ai
security:
  - Bearer: []
tags:
  - name: Health
    x-displayName: Health
  - name: Authentication
    x-displayName: Current credential
  - name: Project API Key
    x-displayName: Project API keys
  - name: Personal API Key
    x-displayName: Personal API keys
  - name: Agent
    x-displayName: Agents
  - name: Agent Endpoint
    x-displayName: Endpoints
  - name: Tool
    x-displayName: Tools
  - name: Agent Setup
    x-displayName: Automatic test setup
  - name: Autoimprove
    x-displayName: Autoimprove
  - name: Customer Flow
    x-displayName: Customer flows
  - name: Customer Flow Folder
    x-displayName: Customer flow folders
  - name: Simulation Persona
    x-displayName: Personas
  - name: Simulation Environment
    x-displayName: Environments
  - name: Simulation Template
    x-displayName: Templates
  - name: Simulation Run Plan
    x-displayName: Plans
  - name: Simulation Run
    x-displayName: Runs
  - name: Simulation Tool Mock
    x-displayName: Tool mocks and fixtures
  - name: Metric
    x-displayName: Definitions
  - name: Metric Variant
    x-displayName: Variants
  - name: Metric Policy
    x-displayName: Policies
  - name: Metric Collection Job
    x-displayName: Collection jobs
  - name: Call
    x-displayName: Calls
  - name: Chat
    x-displayName: Chats
  - name: Customer
    x-displayName: Customers
  - name: Issue
    x-displayName: Issues
  - name: Analytics
    x-displayName: Analytics
  - name: Dashboard
    x-displayName: Dashboards
  - name: Live Report
    x-displayName: Reports
  - name: Agent Connection
    x-displayName: Agent platforms
  - name: Calendar Connection
    x-displayName: Calendars
  - name: MCP Server Connection
    x-displayName: MCP servers
  - name: Knowledge Base
    x-displayName: Knowledge bases
  - name: HTTP Request Definition
    x-displayName: HTTP request definitions
  - name: Webhook
    x-displayName: Webhooks
  - name: Config
    x-displayName: Config as code
  - name: Organization Project
    x-displayName: Projects
  - name: Organization Project Member
    x-displayName: Project members
  - name: Usage
    x-displayName: Usage
  - name: Benchmark
    x-displayName: Benchmarks
paths:
  /v1/simulation/run-group:
    get:
      tags:
        - Simulation Run
      summary: List run groups
      description: >-
        Returns the run groups in the project, newest first, with their runs and
        where each group report stands. Read a report document from `GET
        /v1/simulation/run-group/{groupId}`.
      operationId: getV1SimulationRun-group
      parameters:
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
            description: 'Maximum number of run groups to return (default: 20, max: 100)'
        - in: query
          name: offset
          schema:
            type: integer
            minimum: 0
            default: 0
            description: Pagination offset
      responses:
        '200':
          description: Paginated list of run groups
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSimulationRunGroupsResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Validation error
              example:
                type: validation
                code: invalid_parameter
                message: The request was invalid
                param: email
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Rate limit error
              example:
                type: rate_limit
                code: too_many_requests
                message: Rate limit exceeded
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Roark from '@roarkanalytics/sdk';

            const client = new Roark({
              bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
            });

            const simulationRunGroups = await client.simulationRunGroup.list();

            console.log(simulationRunGroups.data);
        - lang: Python
          source: |-
            import os
            from roark_analytics import Roark

            client = Roark(
                bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
            )
            simulation_run_groups = client.simulation_run_group.list()
            print(simulation_run_groups.data)
components:
  schemas:
    ListSimulationRunGroupsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SimulationRunGroupListItem'
        pagination:
          type: object
          properties:
            limit:
              type: integer
            offset:
              type: integer
            total:
              type: integer
              description: Total run groups in the project, ignoring this page.
            hasMore:
              type: boolean
          required:
            - limit
            - offset
            - total
            - hasMore
      required:
        - data
        - pagination
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation
            - authentication
            - forbidden
            - not_found
            - conflict
            - payment_required
            - rate_limit
            - internal
          description: The error type category
          examples:
            - validation
            - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
            - invalid_parameter
            - missing_required_field
            - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
            - The request was invalid
            - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
            - email
            - user_id
        details:
          description: Additional error context information
      required:
        - type
        - code
        - message
    SimulationRunGroupListItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        createdAt:
          type: string
          description: ISO 8601
        runCount:
          type: integer
        runs:
          type: array
          items:
            $ref: '#/components/schemas/SimulationRunGroupRun'
        latestReport:
          oneOf:
            - $ref: '#/components/schemas/SimulationRunGroupReportSummary'
            - type: 'null'
          description: >-
            Where the latest group report stands. Read the document from `GET
            /v1/simulation/run-group/{groupId}`.
      required:
        - id
        - name
        - createdAt
        - runCount
        - runs
        - latestReport
    SimulationRunGroupRun:
      type: object
      properties:
        simulationRunPlanJobId:
          type: string
          format: uuid
          description: The run, readable at GET /v1/simulation/plan/job/{jobId}
        simulationRunPlanId:
          type: string
          format: uuid
        planName:
          type:
            - string
            - 'null'
          description: The name of the plan the run ran. Null when the plan was deleted.
        runNumber:
          type:
            - integer
            - 'null'
          description: Per-project run number, shown as SR-42 in the app.
        status:
          type: string
          enum:
            - PENDING
            - QUEUED
            - CREATING_SNAPSHOTS
            - CREATING_SIMULATIONS
            - PREPARING_CAPACITY
            - RUNNING_SIMULATIONS
            - COMPLETED
            - FAILED
            - TIMED_OUT
            - CANCELLED
            - CANCELLING
            - ENDING_SIMULATIONS
        createdAt:
          type: string
          description: ISO 8601
        startedAt:
          type:
            - string
            - 'null'
        endedAt:
          type:
            - string
            - 'null'
      required:
        - simulationRunPlanJobId
        - simulationRunPlanId
        - planName
        - runNumber
        - status
        - createdAt
        - startedAt
        - endedAt
      description: One run in the group, in group order.
    SimulationRunGroupReportSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - PENDING
            - GENERATING
            - READY
            - FAILED
          description: >-
            PENDING and GENERATING are in flight; READY carries the document;
            FAILED carries errorMessage.
        errorMessage:
          type:
            - string
            - 'null'
        createdAt:
          type: string
          description: ISO 8601
        completedAt:
          type:
            - string
            - 'null'
          description: ISO 8601. Null until the report settles.
      required:
        - id
        - status
        - errorMessage
        - createdAt
        - completedAt
      description: Where the group report stands, without its document.
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.