v1
latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MBSimulations
Get all scenarios
Retrieve a paginated list of scenarios for the authenticated user's organization and project.
get/simulations
Query parameters
projectIdstring required
Project identifier
filterstring
Filter criteria for searching scenarios
limitinteger
Number of items to return per page
skipinteger
Number of items to skip
sortstring
Sort order (e.g., 'name:asc', 'createdAt:desc')
nextstring
Pagination cursor for next page
previousstring
Pagination cursor for previous page
includeUpcomingScheduleboolean
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