v1

latestOpenAPI 3.0.1Gremlin License2026-08-06397451577.0 KB

scenarios

Get a team's active FI scenario runs ordered by start time desc.

Requires the privilege SCENARIOS_READ

get/scenarios/active/paged

Query parameters

pageSizeinteger

This value determines how many results will be returned per call.

pageTokenstring

Pass the pageToken to get the next page of active FI scenario runs

teamIdstring required

Required when using company session token.

Response

default response

pageNumberinteger

pageSizeinteger

The size of the page requested. If none was supplied this is a default value (depending on the endpoint). If the length of items is less than this number that means there are no more pages to request.

NOTE: if the length is equal there may or may not be additional pages to request, it is unknowable until they are requested

pageTokenstring

Supply this token on successive requests to retrieve the next page if there is one