---
title: "List assessments"
method: GET
path: "/v1/assessments"
tags: ["Assessments"]
---

# List assessments

`GET /v1/assessments`

## Request

- Base URL: `https://api.ironfang.com/security`
- URL: `https://api.ironfang.com/security/v1/assessments`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Every collection run in the organisation, newest first, External Security Checks included.

## Query parameters

- `asset_id` string, uuid
- `source_type` 'external_scan' | 'wordpress_agent' | 'linux_agent' | 'kubernetes_agent' | 'container_scanner' | 'cloud_integration' | 'dependency_scanner' | 'ai_assessment' | 'nuclei' | 'import' | 'manual': What kind of producer a result came from. external_scan is the External Security Check and cannot be submitted.
- `cursor` string
- `limit` integer

## Response `200`

Assessments.

- object
  - `items` Assessment[], required
    - `asset` AssetRef, required
      - `id` string, uuid, required
      - `name` string, required
      - `type` 'domain' | 'hostname' | 'ip_address' | 'service' | 'website' | 'host' | 'virtual_machine' | 'container' | 'container_image' | 'kubernetes_cluster' | 'kubernetes_namespace' | 'cloud_account' | 'wordpress_installation' | 'repository' | 'application' | 'api', required
    - `batches_received` integer, required
    - `checks` object
      - `attempted` integer, required
      - `completed` integer, required
      - `failed` integer, required
    - `client_reference` string
    - `completed_at` string, date-time
    - `created_at` string, date-time, required
    - `expires_at` string, date-time: While open, when it fails if not completed.
    - `findings` object, required
      - `new` integer, required
      - `observed` integer, required
      - `reopened` integer, required
      - `resolved` integer, required
    - `id` string, uuid, required
    - `protocol_version` integer, required
    - `results_received` integer, required
    - `scan_id` string, uuid: The External Security Check this assessment is.
    - `source` object, required
      - `instance` string
      - `name` string, required
      - `type` 'external_scan' | 'wordpress_agent' | 'linux_agent' | 'kubernetes_agent' | 'container_scanner' | 'cloud_integration' | 'dependency_scanner' | 'ai_assessment' | 'nuclei' | 'import' | 'manual', required: What kind of producer a result came from. external_scan is the External Security Check and cannot be submitted.
      - `version` string, required
    - `started_at` string, date-time
    - `status` 'queued' | 'running' | 'completed' | 'partial' | 'failed' | 'cancelled', required
    - `status_reason` string
  - `next_cursor` string, required

## Other responses

- `401`: An error.
- `403`: An error.
- `default`: An error.

---

[API](https://skmtc.dev/ironfang/apis/ironfang-security-api.md) · [All operations](https://skmtc.dev/ironfang/apis/ironfang-security-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ironfang/apis/ironfang-security-api/revisions/73bd66283d59?raw)