---
title: "List scans"
method: GET
path: "/scans"
tags: ["Scans"]
---

# List scans

`GET /scans`

## Request

- Base URL: `https://public.escape.tech/v3`
- URL: `https://public.escape.tech/v3/scans`
- Auth: API key in header `X-ESCAPE-API-KEY`

List and search scans of the organization.

## Query parameters

- `cursor` string: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.
- `size` integer: The number of items to return per page
- `sortType` 'SEVERITY' | 'createdAt': The type to sort by
- `sortDirection` 'asc' | 'desc': The direction to sort by
- `after` string: Filter by after date
- `before` string: Filter by before date
- `search` string: Search term to filter scans
- `assetIds` union: Filter by asset IDs
  - string
  - string[]
- `profileIds` union: Filter by profile IDs
  - string
  - string[]
- `tagIds` union: Filter by tag IDs
  - string
  - string[]
- `assetTypes` string[]: Filter by asset types
- `ignored` 'true' | 'false': Filter by ignored status
- `initiator` string[]: Filter by initiator
- `kinds` string[]: Filter by kind
- `status` string[]: Filter by status
- `projectIds` union: Filter by project IDs
  - string
  - string[]
- `problemCodes` string[]: Filter by problem codes
- `problemSeverities` string[]: Filter by problem severities
- `noTags` 'true' | 'false': Filter by assets with no tags
- `commitBranch` string: Filter by commit branch. Not supported by the GraphQL where input, so it is applied after fetching.
- `latestBranchScans` 'true' | 'false': Keep only the latest scan of each commit branch. Not supported by the GraphQL where input, so it is applied after fetching.
- `dnf` string: Filter by DNF expression

## Response `200`

OK

- object
  - `nextCursor` string, nullable, required
  - `totalCount` integer
  - `data` object[], required
    - `id` string, uuid, required: The id of the scan
    - `profileId` string, uuid, nullable, required: The id of the profile that ran the scan
    - `assetId` string, uuid, nullable, required: The id of the asset that was scanned, if any
    - `status` string, required: The status of the scan
    - `createdAt` string, required: The date and time the scan was created
    - `finishedAt` string, nullable, required: The date and time the scan was finished
    - `score` number, nullable, required: The score of the scan
    - `coverage` number, nullable, required: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data
    - `duration` number, required: The duration of the scan
    - `progressRatio` number, required: The progress ratio of the scan
    - `initiator` string, required: The initiator of the scan
    - `kind` string, required: The kind of the scan
    - `commitHash` string, nullable, required: The commit hash of the scan
    - `commitBranch` string, nullable, required: The commit branch of the scan
    - `links` object, required: The links of the scan
      - `scanIssues` string, required: The url to view the scan issues in the platform

## Other responses

- `400`: Pagination error

---

[API](https://skmtc.dev/escape/apis/escape-public-api.md) - [All operations](https://skmtc.dev/escape/apis/escape-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/escape/apis/escape-public-api/revisions/2eab35df40c7?raw)