---
title: "List Batch Runs"
method: GET
path: "/v1/batch-runs"
tags: ["Batch Runs"]
---

# List Batch Runs

`GET /v1/batch-runs`

Returns a paginated list of batch runs for the specified agent, sorted by most recently created first. Use page and size to navigate through results.

## Query parameters

- `agentId` string, required
- `page` integer
- `size` integer

## Response `200`

OK

- PaginatedResponseBatchResponse — Standard wrapper for paginated API responses. Use this when returning list data that is split across multiple pages. Includes the current page of results along with pagination metadata to help clients navigate through large datasets efficiently.
  - `data` BatchResponse[] — List of items for the current page. Contains up to 'size' number of records.
    - `batchId` string — The unique identifier of the batch run.
    - `workspaceId` string — The unique identifier of the workspace under which the batch run was created.
    - `agent` AgentResponse — Agent assigned to handle all calls in this campaign. Contains the agent's ID, name, and current status. All contacts in the campaign's contact list will be called using this agent.
      - `name` string — The display name of the assigned agent.
      - `agentId` string — The unique identifier of the agent within the system.
      - `status` 'Live' | 'Testing' | 'Disabled' — The current operational status of the agent.
    - `createdDate` string, date-time — The UTC timestamp indicating when the batch run was created.
    - `testCases` TestCaseResponse[] — The list of test cases included in this batch run, along with their individual simulation results.
      - `testCaseId` string — The unique identifier of the test case.
      - `label` string — A human-readable name or label for the test case, used to identify it in reports and dashboards.
      - `agent` AgentResponse — Agent assigned to handle all calls in this campaign. Contains the agent's ID, name, and current status. All contacts in the campaign's contact list will be called using this agent.
        - `name` string — The display name of the assigned agent.
        - `agentId` string — The unique identifier of the agent within the system.
        - `status` 'Live' | 'Testing' | 'Disabled' — The current operational status of the agent.
      - `workspaceId` string — The unique identifier of the workspace under which this test case was created.
      - `llmModel` string — The LLM model used to generate Agent responses during the simulation.
      - `mockData` MockDataResponse[] — The list of mock variables and their simulated values that were used to substitute for real external data sources during the simulation.
        - `variableName` string — The name of the variable that was substituted with mock data during the simulation.
        - `value` string — The simulated value that was assigned to the variable for the duration of the test run.
      - `userPrompt` string — The prompt that defined the persona and intent of the simulated user, driving the user-side messages throughout the conversation.
      - `attempt` integer — The number of times this test case was configured to run as independent simulation attempts.
      - `successCriteria` string — The plain-language description of what a successful agent response looks like, used to evaluate the agent's performance after each simulation run.
    - `successfulAttempts` integer — The total number of simulation attempts across all test cases in this batch run that were evaluated as successful.
    - `failedAttempts` integer — The total number of simulation attempts across all test cases in this batch run that were evaluated as failed.
    - `totalAttempts` integer — The total number of simulation attempts executed across all test cases in this batch run.
  - `page` integer — Current page number (0-based index). Indicates which page of results is being returned.
  - `size` integer — Number of items requested per page. Determines the maximum size of the 'data' list.
  - `totalCount` integer — Total number of records available across all pages. Useful for calculating pagination on the client side.
  - `totalPages` integer — Total number of pages available based on totalCounts and size. Helps clients understand how many pages exist in total.
  - `hasNext` boolean — Indicates whether there is a next page available after the current one. Useful for implementing 'Load More' or next navigation.
  - `hasPrevious` boolean — Indicates whether there is a previous page before the current one. Useful for enabling backward navigation.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/sigmamind/apis/sigmamind-apis.md) · [All operations](https://skmtc.net/sigmamind/apis/sigmamind-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sigmamind/sigmamind-apis/revisions/d00f52b5123f/schema)
