Skip to main content
GET
/
workflows
/
v1
/
simulations
Get Simulations
curl --request GET \
  --url https://api-qa.interactly.ai/workflows/v1/simulations \
  --header 'Authorization: Bearer <token>'
{
  "simulations": [
    {
      "team_id": "<string>",
      "created_by": "<string>",
      "updated_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "_id": "5eb7cf5a86d9755df3a6c593",
      "simulation_config": {
        "logical_id": "<string>",
        "description": "<string>",
        "selected_workflow": {
          "workflow_id": "<string>",
          "dynamic_variables": {},
          "name": "<string>",
          "total_events": 0,
          "total_nodes": 0,
          "total_duration_seconds": 0,
          "run_id": "<string>"
        },
        "counter_workflow": {
          "workflow_id": "<string>",
          "dynamic_variables": {},
          "name": "<string>",
          "total_events": 0,
          "total_nodes": 0,
          "total_duration_seconds": 0,
          "run_id": "<string>"
        },
        "timeout_seconds": 123,
        "max_events": 500,
        "number_of_simulations": 1,
        "stop_on_failure": false,
        "status": "pending"
      }
    }
  ],
  "total": 123
}

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Query Parameters

size
integer
default:100

Number of items per page

Required range: x >= 1
page
integer
default:1

Page number

Required range: x >= 1
search
string | null

Search keywords

start
string<date-time> | null

Filter by start time (ISO 8601 format)

end
string<date-time> | null

Filter by end time (ISO 8601 format)

logical_id
string | null
selected_workflow_id
string | null
Required string length: 24
Example:

"5eb7cf5a86d9755df3a6c593"

counter_workflow_id
string | null
Required string length: 24
Example:

"5eb7cf5a86d9755df3a6c593"

status
enum<string> | null
Available options:
pending,
running,
completed,
failed,
cancelled

Response

Successful Response

Response model for a list of simulations. Contains a list of SimulationsModel objects.

simulations
SimulationsModel · object[]

List of simulations

total
integer | null

Total number of simulations available without pagination.