Skip to main content
POST
/
simulators
/
routines
/
list
Filter Simulator Routines
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/routines/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {
    "modelExternalIds": [
      "<string>"
    ],
    "simulatorIntegrationExternalIds": [
      "<string>"
    ],
    "simulatorExternalIds": [
      "<string>"
    ]
  },
  "limit": 1000,
  "cursor": "<string>",
  "sort": [
    {
      "order": "asc",
      "property": "createdTime"
    }
  ]
}
'
{
  "items": [
    {
      "dataSetId": 123,
      "id": 123,
      "externalId": "<string>",
      "simulatorExternalId": "<string>",
      "modelExternalId": "<string>",
      "simulatorIntegrationExternalId": "<string>",
      "name": "<string>",
      "createdTime": 123,
      "lastUpdatedTime": 123,
      "description": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Body

application/json
filter
ListSimulatorRoutinesFilters · object
limit
integer
default:1000
Required range: 1 <= x <= 1000
cursor
string

Cursor for pagination

sort
SortByCreatedTime · object[]

Only supports sorting by one property at a time

Response

Successful Response

items
SimulatorRoutineBase · object[]
required
nextCursor
string
Last modified on April 23, 2026