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

# Get List of Websites

`GET /api/cmp/v1/webscans`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/cmp/v1/webscans`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `COOKIE`, `COOKIE_READ`

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.
    - `domainName` string: The name of the website domain.
    - `domainId` string, uuid: The unique identifier of the domain.
    - `status` string: The current state or condition of the item.
    - `lastScannedDate` string, date-time: The date and time when the domain was last scanned for cookies.
    - `lastScannedTotalCookies` integer: The total number of cookies found during the last scan.
    - `uniqueCookiesFound` integer: The number of unique cookies discovered during scanning.
    - `lastScannedTotalPages` integer: The total number of pages scanned during the last scan.
    - `maxPagesScanned` integer: The maximum number of pages that can be scanned.
    - `scheduledDateOfNextScan` string, date-time: The date and time when the next scan is scheduled to run.
    - `consentPolicyName` string: The name of the consent policy that is applied.
    - `scanError` string: The error message if the scan operation failed.
    - `orgName` string: The name of the organization.
    - `externalOrgId` string: The external organization identifier.
    - `overPageLimit` boolean: This flag indicates whether the scan exceeded the maximum page limit.
  - `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: This flag indicates whether the result set is empty.
    - `sorted` boolean: This flag indicates whether the results are sorted.
    - `unsorted` boolean: This flag indicates whether the results are in unsorted order.
  - `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.dev/onetrust/apis/consent-preferences-cookie-consent.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent/revisions/b4fb4606f973?raw)