---
title: "Get List of Scans by Domain"
method: GET
path: "/api/cmp/v1/webscans/domains/{domainId}/scans"
tags: ["Scans"]
---

# Get List of Scans by Domain

`GET /api/cmp/v1/webscans/domains/{domainId}/scans`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/cmp/v1/webscans/domains/{domainId}/scans`
- 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 scans for a specific domain and the specified filter criteria.

## Path parameters

- `domainId` string, uuid, required

## Query parameters

- `status` 'QUEUED' | 'PENDING' | 'INPROGRESS' | 'MIGRATION_STARTED' | 'MIGRATION_COMPLETED' | 'CATEGORIZATION_STARTED' | 'CATEGORIZATION_FAILED' | 'COMPLETED' | 'ERROR' | 'CANCELLED' | 'SCANNING' | 'DATA_MOVE' | 'RETRY_BY_AUTO_CORRECT' | 'MS_IOS_SCAN_SUCCESS' | 'MS_IOS_SCAN_FAILED' | 'MS_EXPORT_XLS_STARTED' | 'MS_EXPORT_PDF_STARTED' | 'SCHEDULED'
- `archiveStatus` 'NONE' | 'PENDING_UI' | 'PENDING_SCHEDULED' | 'ARCHIVE_STARTED' | 'ARCHIVE_COMPLETED' | 'ARCHIVE_QUEUED' | 'ERROR' | 'NO_DATA_TO_EXPORT'
- `startDate` string, date
- `endDate` string, date
- `page` integer
- `size` integer

## Response `200`

OK

- PageScanInformationResponse
  - `totalPages` integer: The total number of pages in the paginated results.
  - `totalElements` integer: The total number of items in the complete result set.
  - `size` integer: The number of items to return per page.
  - `content` ScanInformationResponse[]: The main content or data payload of the response.
    - `scanId` string, uuid: The unique identifier of the scan.
    - `domainId` string, uuid: The unique identifier of the domain.
    - `startingUrl` string: The initial URL where the scanning process begins.
    - `sequence` integer: The order or position in a sequential series.
    - `crawlStartDt` string, date-time: The date and time when the crawling process started.
    - `crawlEndDt` string, date-time: The date and time when the crawling process ended.
    - `usedQueryParameters` string: The query parameters that were used during the scanning process.
    - `scanPageLimit` integer: The maximum number of pages allowed per scan operation.
    - `pagesScanned` integer: The number of pages that were actually scanned.
    - `errorDescription` string: The description of any error that occurred.
    - `cookieNotice` boolean: The notice or information about cookie usage.
    - `retryCount` integer: The number of times the operation was retried.
    - `totalPagesFound` integer: The total number of pages discovered during scanning.
    - `cookiesFound` integer: The number of cookies discovered during scanning.
    - `geoLocation` string: The geographic location settings for the scan.
    - `limitScanToSitemap` boolean: This flag indicates whether to restrict scanning to sitemap URLs only.
    - `status` 'QUEUED' | 'PENDING' | 'INPROGRESS' | 'MIGRATION_STARTED' | 'MIGRATION_COMPLETED' | 'CATEGORIZATION_STARTED' | 'CATEGORIZATION_FAILED' | 'COMPLETED' | 'ERROR' | 'CANCELLED' | 'SCANNING' | 'DATA_MOVE' | 'RETRY_BY_AUTO_CORRECT' | 'MS_IOS_SCAN_SUCCESS' | 'MS_IOS_SCAN_FAILED' | 'MS_EXPORT_XLS_STARTED' | 'MS_EXPORT_PDF_STARTED' | 'SCHEDULED': The current state or condition of the item.
    - `scanType` 'UI_SCAN' | 'SCHEDULE_SCAN': The type or method of scanning being performed.
    - `archiveStatus` 'NONE' | 'PENDING_UI' | 'PENDING_SCHEDULED' | 'ARCHIVE_STARTED' | 'ARCHIVE_COMPLETED' | 'ARCHIVE_QUEUED' | 'ERROR' | 'NO_DATA_TO_EXPORT': The archival state of the scan.
  - `number` integer: The numeric value or identifier.
  - `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.
  - `pageable` PageableObject
    - `offset` integer: The starting position for paginated results.
    - `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.
    - `paged` boolean: This flag indicates whether pagination is enabled.
    - `pageSize` integer: The number of items displayed per page.
    - `pageNumber` integer: The current page number in the pagination sequence.
    - `unpaged` boolean: This flag indicates whether pagination is disabled.
  - `first` boolean: This flag indicates whether this is the first item in a sequence.
  - `last` boolean: This flag indicates whether this is the last item in a sequence.
  - `numberOfElements` integer: The number of items in the current page.
  - `empty` boolean: This flag indicates whether the result set is empty.

## 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)