List scenarios

The unique ID of the team whose scenarios will be retrieved. If this parameter is set, the organizationId parameter must be skipped. For each request either teamId or organizationId must be defined.

The unique ID of the organization whose scenarios will be retrieved. If this parameter is set, the teamId parameter must be skipped. For each request either teamId or organizationId must be defined.

The array of IDs of scenarios to retrieve.

The unique ID of the folder containing scenarios you want to retrieve. By default, only scenarios directly assigned to this folder are returned.

When set to true with folderId, also returns scenarios assigned to descendant folders up to the scenario folder nesting limit.

Returns scenarios carrying any of the given labels (OR semantics) — a scenario is included if it has at least one of the listed labels. Composes with other filters (e.g. folderId, name) using AND. Omit this parameter, or pass an empty array, to skip label filtering. Ignored when deleted is set to true.

Set this parameter to true to get only active scenarios in the response.

This parameter is deprecated. Use the isActive parameter to filter for active scenarios instead.

If set to true, the response contains only scenario concepts.

Limits the type of scenarios to be retrieved.

Set this parameter to true to list scenarios currently in the trash — scenarios that were deleted and are still within the 30-day recovery window. When omitted (the default), deleted scenarios are excluded from the response.

Filters scenarios by name using a case-insensitive substring match.

Set to true to return only invalid scenarios (those whose blueprint failed validation), or false to return only valid ones.

Set to true to return only locked scenarios, or false to return only unlocked ones.

Filters scenarios by the name of the user who created them.

Filters scenarios by the name of the user who last updated them.

Filters scenarios by their number of unresolved incomplete executions.

Specifies columns that are returned in the response. Use the cols[] parameter for every column that you want to return in the response. For example GET /endpoint?cols[]=key1&cols[]=key2 to get both key1 and key2 columns in the response.

Check the "Filtering" section for a full example.

The number of entities you want to skip before getting entities you want.

The maximum number of entities you want to get in the response.

The value that will be used to sort returned entities by.

The sorting direction. Ascending order (asc) is rejected only when sorting by the default proprietal column; for every other sortBy value both asc and desc are allowed. Defaults to desc.