---
title: "# Simulation List"
method: GET
path: "/v1/simulations"
tags: ["Simulations"]
---

# # Simulation List

`GET /v1/simulations`

Simulation List; Simulation ID, Simulation Name, Simulation Agent (with status), Enrichment Status, Last Prevention Result, Last Detection Result (if Available)
Default limit: 25, Default offset: 0
Max limit: 50

## Query parameters

- `limit` integer
- `offset` integer
- `status` string[]
- `simulation_name` string
- `agent_name` string
- `agent_id` integer
- `template_name` string
- `template_id` integer
- `prevention_result_lte` integer
- `prevention_result_gte` integer
- `detection_result_lte` integer
- `detection_result_gte` integer

## Response `200`

SimulationsResponse

- object
  - `pages` Pagination
    - `limit` integer — Limit
    - `offset` integer — Offset
    - `total_count` integer — Total Count
  - `simulations` SimulationSummary[]
    - `agent` AgentSummary
      - `id` integer — Agent Id
      - `name` string — Agent Name
      - `status` string — Agent status gives information about your agent alive (alive | dead | expired)
      - `type` string — Agent type (QuickEmail | Browser | Installable Agent | Windows | Linux | MacOS)
      - `version` string — Agent Version like 3.4.0.0
    - `completion_ratio` integer
    - `detection_analysis` Detection
      - `integrations` Enrichment[] — Integration List
        - `id` integer — Integration Id
        - `product_name` string — Product Name
    - `fail_reason_message` string
    - `has_detection_analysis` boolean — If detection of simulation has no enrichment this field will be false
    - `has_last_run_detection_analysis` boolean — To avoid confusing about has_detection_analysis, if last_detection_score is different from -1 this field will be true
    - `last_detection_security_score` integer — Last running detection security score is between 0 and 100. Logging and alert score calculated together
    - `last_prevention_security_score` integer — Last running prevention security score is between 0 and 100
    - `simulation_id` integer — Simulation Id
    - `simulation_name` string — Simulation Name
    - `status` string — Simulation last run status (RUNNING | COMPLETED | STOPPED | NOT STARTED | SCHEDULED | WAITING FOR THE FIRST RUN)
    - `status_details` StatusDetails
      - `detection` ThreatCounts
        - `completed_threat_count` integer
        - `total_threat_count` integer
      - `prevention` ThreatCounts
        - `completed_threat_count` integer
        - `total_threat_count` integer
    - `template_id` integer — Template Id
    - `template_name` string — Template Name
    - `updated_at` integer — Simulation Updated At

## Other responses

- `422` — validationErrorSwagger is represents the erroneous cases
- `default` — genericErrorSwagger is represents the erroneous cases

---

[API](https://skmtc.net/picussecurity/apis/picus-rest-api.md) · [All operations](https://skmtc.net/picussecurity/apis/picus-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/picussecurity/picus-rest-api/versions/cb0d02ee28f8/schema)