List scenarios

List scenarios in the current workspace

GET /api/v1/scenarios

List scenarios

cURL

curl --request GET \
  --url https://dev.simforge.ai/api/v1/scenarios \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "mapId": "<string>",
      "mapVersionId": "<string>",
      "latestRevisionId": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "tags": [
        "<string>"
      ],
      "datasetIds": [
        "<string>"
      ]
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization · string · header · required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Query Parameters

cursor · string

Minimum string length: 1

limit · integer · default: 50

Required range: 1 <= x <= 100

Response

200

application/json

Scenarios.

data · object[] · required

Show child attributes

nextCursor · string | null · required