INinteractly
Simulations

Get Simulations

Endpoint to retrieve all simulations.

get/workflows/v1/simulations

Request

  • Base URL
    https://api-qa.interactly.ai
  • URL
    https://api-qa.interactly.ai/workflows/v1/simulations
  • Auth
    HTTP bearer

Query parameters

sizeinteger

Number of items per page

pageinteger

Page number

searchstring nullable

Search keywords

startstring date-time nullable

Filter by start time (ISO 8601 format)

endstring date-time nullable

Filter by end time (ISO 8601 format)

logical_idstring nullable
selected_workflow_idstring
Example:5eb7cf5a86d9755df3a6c593
counter_workflow_idstring
Example:5eb7cf5a86d9755df3a6c593
status'pending' | 'running' | 'completed' | 'failed' | 'cancelled'
selected_version_numberinteger nullable
counter_version_numberinteger nullable

Response

Successful Response

totalinteger nullable

Total number of simulations available without pagination.

Example response

{
  "simulations": [
    {
      "_id": "5eb7cf5a86d9755df3a6c593"
    }
  ]
}

Changes

No recorded changes to this operation across all 60 revisions of this API.