---
title: "Get List of Websites"
method: GET
path: "/api/cmp/v1/webscans"
tags: ["Scans"]
---

# Get List of Websites

`GET /api/cmp/v1/webscans`

Use this API to retrieve a list of websites in the scanner. The response will return websites in Pending and Completed status for the organization and related child organizations.

## Query parameters

- `searchStr` string
- `externalOrgId` string
- `page` integer
- `size` integer
- `sortBy` 'Url' | 'PagesScanned' | 'TotalCookieCount' | 'LastScannedDate' | 'ConsentPolicyName' | 'ScheduledNextScanDate' | 'MaxPagesScanned'
- `direction` 'ASC' | 'DESC'

## Response `200`

OK

- ExposedScanWebsitePageResponseDto
  - `content` ExposedWebsiteDetailsDto[] — The main content or data payload of the response.
    - `consentPolicyName` string — Name of the assigned consent policy to the website.
    - `domainName` string — Name of the domain.
    - `domainId` string, UUID — ID of the domain.
    - `externalOrgId` string — ID of the external organization for the website scan.
    - `lastScannedDate` string, date-time — The date and time at which the domain was last scanned.
    - `lastScannedTotalCookies` integer — Total cookies found on the last scan.
    - `lastScannedTotalPages` integer — Total pages scanned in the last scan.
    - `orgName` string — Name of the organization.
    - `overPageLimit` boolean — The flag to indicate if it is over the tenant page limit.
    - `scanError` string — Error message if any in the scan.
    - `scheduledDateOfNextScan` string, date-time — The date and time at which the next scan is scheduled.
    - `status` string — Status of the scan.
  - `totalElements` integer — The total number of items in the complete result set.
  - `totalPages` integer — The total number of pages in the paginated results.
  - `pageSize` integer — The number of items displayed per page.
  - `pageNumber` integer — The current page number in the pagination sequence.
  - `sort` SortObject
    - `empty` boolean
    - `sorted` boolean
    - `unsorted` boolean
  - `numberOfElements` integer — The number of items in the current page.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500` — Internal Server Error

---

[API](https://skmtc.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/versions/21de3aa0b170/schema)