Skip to main content
GET
/
simulations
/
batches
Get all simulations
curl --request GET \
  --url https://api-trial.cognigy.ai/testing/simulations/batches \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "referenceId": "<string>",
      "simulationReference": "<string>",
      "runs": 123,
      "completedRuns": 123,
      "failedRuns": 123,
      "createdAt": 123,
      "startedAt": 123,
      "completedAt": 123
    }
  ],
  "pagination": {
    "limit": 123,
    "skip": 123,
    "total": 123,
    "hasNext": true,
    "hasPrevious": true,
    "next": "<string>",
    "previous": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT Bearer Token for authentication

Query Parameters

projectId
string
required

Project identifier

filter
string

Filter criteria for searching simulations

limit
integer
default:20

Number of items to return per page

Required range: 1 <= x <= 100
skip
integer
default:0

Number of items to skip

Required range: x >= 0
sort
string

Sort order (e.g., 'name:asc', 'createdAt:desc')

next
string

Pagination cursor for next page

previous
string

Pagination cursor for previous page

status
enum<string>

Filter by simulation status

Available options:
STOPPED,
IN_PROGRESS,
COMPLETED,
FAILED
timespan
string

Filter by time range (e.g., '7d', '30d', '1y')

timezone
string

Timezone for timespan filtering (e.g., 'UTC', 'America/New_York')

endPointType
string

Filter by endpoint type

scenariosIds
string[]

Filter by simulation references (comma-separated list of simulation IDs)

Response

List of simulations retrieved successfully

data
object[]

Array of simulation objects

pagination
object
Last modified on July 2, 2026