Skip to main content
POST
/
simulators
/
list
Filter Simulators
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {},
  "limit": 1000
}
'
{
  "items": [
    {
      "id": 123,
      "externalId": "<string>",
      "name": "<string>",
      "fileExtensionTypes": [
        "<string>"
      ],
      "createdTime": 123,
      "lastUpdatedTime": 123,
      "modelTypes": [
        {
          "name": "<string>",
          "key": "<string>"
        }
      ],
      "stepFields": [
        {
          "stepType": "<string>",
          "fields": [
            {
              "name": "<string>",
              "label": "<string>",
              "info": "<string>",
              "options": [
                {
                  "label": "<string>",
                  "value": "<string>"
                }
              ]
            }
          ]
        }
      ],
      "unitQuantities": [
        {
          "name": "<string>",
          "label": "<string>",
          "units": [
            {
              "label": "<string>",
              "name": "<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
ListSimulatorsFilters · object
limit
integer
default:1000
Required range: 1 <= x <= 1000

Response

Successful Response

items
Simulator · object[]
required
Last modified on April 23, 2026