Skip to main content
GET
/
simulations
Get all scenarios
curl --request GET \
  --url https://api-trial.cognigy.ai/testing/simulations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "referenceId": "<string>",
      "name": "<string>",
      "persona": "<string>",
      "personaName": "<string>",
      "mission": "<string>",
      "successCriteria": [
        {
          "type": "<string>",
          "params": {}
        }
      ],
      "organisationReference": "<string>",
      "projectReference": "<string>",
      "createdAt": 123,
      "createdBy": "<string>",
      "lastChanged": 123,
      "lastChangedBy": "<string>",
      "maxTurns": 123,
      "timeout": 123,
      "aiAgentReferenceId": "<string>",
      "aiAgentId": "<string>",
      "flowReferenceId": "<string>",
      "flowId": "<string>",
      "jobNodeId": "<string>",
      "updatedAt": 123,
      "updatedBy": "<string>",
      "nextScheduledRun": "2023-11-07T05:31:56Z"
    }
  ],
  "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 scenarios

​
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

​
includeUpcomingSchedule
boolean
default:false

When true, each scenario in the response is enriched with the nextScheduledRun of its soonest upcoming enabled schedule (or null if no upcoming schedule exists). Any value other than the literal true is treated as false and the field is omitted.

Response

List of scenarios retrieved successfully

​
data
object[]

Array of scenario objects

​
pagination
object
Last modified on July 2, 2026