---
title: "Get Scans Status"
method: GET
path: "/v1/scans"
tags: ["scans"]
---

# Get Scans Status

`GET /v1/scans`

Get user scans status

## Query parameters

- `offset` integer
- `limit` integer
- `search` string
- `status` string

## Response `200`

Example response

- object
  - `message` string, required
  - `data` ScanStatusItem[], required
    - `scan_id` string, required
    - `status` string, required
    - `scan_time_elapsed` string, required
    - `progress` integer, required
    - `failure_reason` string, required
    - `created_at` string, required
    - `updated_at` string, required
    - `total_target` integer, required
    - `completed_at` string, required
    - `total_scan` integer, required
    - `total_template` integer, required
    - `name` string, required
    - `severity` object
    - `is_oss` boolean, required
    - `is_cloud` boolean, required
    - `scan_frequency` string
    - `schedule_last_run` string
    - `asset_ids` string[]
    - `is_rescan` boolean
    - `public_templates` string[]
    - `report_config_ids` string[]
    - `rescan_count` integer
    - `scan_config_ids` string[]
    - `template_ids` string[]
    - `template_urls` string[]

## Other responses

- `400` — Example response
- `401` — Example response
- `500` — Example response

## Changes

- **2024-01-31** `4f557b176ebd` — 7 breaking, 12 warning, 40 info
  - for the `query` request parameter `offset`, the type changed from `string` to `integer`
  - the `data/items/is_cloud` response's property type changed from `string` to `boolean` for status `200`
  - the `data/items/is_cloud` response's property type changed from `string` to `boolean` for status `401`
  - the `data/items/is_oss` response's property type changed from `string` to `boolean` for status `200`
  - …55 more
- **2023-12-08** `5bcc3de1c2c5` — 1 info
  - for the `query` request parameter `offset`, the type was generalized from `integer` to `string`
- **2023-12-06** `35be9c1301b7` — 1 info
  - api tag `scans` added
- **2023-12-05** `5c3748c387f7` — 17 breaking, 25 warning, 15 info
  - the `query` request parameter `limit` became required
  - the `query` request parameter `offset` became required
  - the response property `data/items/completed_at` became optional for the status `200`
  - the response property `data/items/failure_reason` became optional for the status `200`
  - …53 more

[Change history](https://skmtc.dev/projectdiscovery/apis/pdcp-api/changes/v1/scans/get.md)

---

[API](https://skmtc.dev/projectdiscovery/apis/pdcp-api.md) · [All operations](https://skmtc.dev/projectdiscovery/apis/pdcp-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/projectdiscovery/pdcp-api/revisions/4f557b176ebd/schema)