---
title: "Get Scan List"
method: GET
path: "/v1/scans"
tags: ["scans"]
---

# Get Scan List

`GET /v1/scans`

Get user scans status

## Query parameters

- `offset` integer
- `limit` integer
- `search` string
- `status` string
- `sort_asc` string
- `sort_desc` string
- `is_internal` boolean

## Headers

- `X-Team-Id` string

## Response `200`

Example response

- object
  - `current_page` integer, required
  - `result_count` integer, required
  - `total_results` integer, required
  - `total_pages` integer, required
  - `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
    - `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[]
    - `schedule` ScanSchedule
      - `scan_frequency` string, required
      - `scan_id` string, required
      - `schedule_last_run` string, required
      - `schedule_next_run` string, required
      - `start_time` string, time
      - `hourly_frequency` integer
      - `custom_weekdays` integer[] — Array of integer denoting the weekdays on which the scan is supposed to run. 0-6 denoting Sunday-Saturday.
    - `total_result` integer, required
    - `is_automatic` boolean
    - `agent_id` string
    - `agent_tags` string[]
    - `agent_networks` string[]
    - `agent_behavior` 'distribute' | 'mirror'
    - `is_internal` boolean

## Other responses

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

## Changes

> 22 revisions in range; 1 could not be searched.

- **2025-11-18** `41ee26b930f3` — 6 info
  - added the new optional `query` request parameter `is_internal`
  - added the optional property `data/items/agent_behavior` to the response with the `200` status
  - added the optional property `data/items/agent_id` to the response with the `200` status
  - added the optional property `data/items/agent_networks` to the response with the `200` status
  - …2 more
- **2025-08-13** `c41cd7ae7718` — 1 info
  - added the optional property `data/items/is_automatic` to the response with the `200` status
- **2024-09-22** `407b73d9ce28` — 2 info
  - added the new optional `header` request parameter `X-Team-Id`
  - added the required property `data/items/total_result` to the response with the `200` status
- **2024-04-19** `ba8a20839440` — 7 breaking, 2 warning, 26 info
  - removed the media type `application/xml` for the response with the status `200`
  - removed the media type `application/xml` for the response with the status `400`
  - removed the media type `application/xml` for the response with the status `401`
  - removed the media type `application/xml` for the response with the status `500`
  - …31 more
- …earlier changes not shown

[Full 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/220f0adf9efd/schema)