---
title: "List simulation groups"
method: GET
path: "/v1/simulation/group"
tags: ["Simulation"]
---

# List simulation groups

`GET /v1/simulation/group`

## Request

- Base URL: `https://api.roark.ai`
- URL: `https://api.roark.ai/v1/simulation/group`
- Auth: HTTP bearer

Returns the saved simulation groups in the project, most recently edited first, each with its plans in run order and notification settings.

## Query parameters

- `limit` integer: Maximum number of groups to return (default: 20, max: 100)
- `offset` integer: Pagination offset

## Response `200`

Paginated list of simulation groups

- ListSimulationGroupsResponse
  - `data` SimulationGroup[], required
    - `id` string, uuid, required
    - `name` string, required
    - `description` string, nullable, required
    - `configManaged` boolean, required: Whether this group is managed by config as code. A managed group can be run here, but PUT and DELETE on it return 409: change it in the config file.
    - `plans` object[], required: The plans in run order. A plan deleted since it was added is left out.
      - `id` string, uuid, required: The plan, readable at GET /v1/simulation/plan/{planId}
      - `name` string, required
    - `notifications` object, required: Where each run's group report announces itself once it is ready.
      - `email` object, required
        - `enabled` boolean, required
        - `recipients` string[], required
      - `slack` object[], required
        - `channelId` string, required
        - `channelName` string, required
    - `lastRunAt` string, nullable, required: ISO 8601. Null when it has never run.
    - `latestRunGroupId` string, uuid, nullable, required: The most recent run group it started, readable at GET /v1/simulation/run-group/{groupId}. Null when it has never run.
    - `createdAt` string, required: ISO 8601
    - `updatedAt` string, required: ISO 8601
  - `pagination` object, required
    - `limit` integer, required
    - `offset` integer, required
    - `total` integer, required: Total groups in the project, ignoring this page.
    - `hasMore` boolean, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

> 187 revisions in range; 1 not diffed.

- **2026-10-14** `d88d1b582569`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/roarkhq/apis/roark-analytics-api/changes/v1/simulation/group/get.md)

---

[API](https://skmtc.dev/roarkhq/apis/roark-analytics-api.md) - [All operations](https://skmtc.dev/roarkhq/apis/roark-analytics-api/llms.txt) - [OpenAPI document](https://skmtc.dev/roarkhq/apis/roark-analytics-api/revisions/1a91a5c90e44?raw)