> ## Documentation Index
> Fetch the complete documentation index at: https://developer.onetrust.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get List of Scans by Domain

Use this API to retrieve a list of scans for a specific domain and the specified filter criteria.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Consent & Preferences - Cookie Consent",
    "version": "1.0",
    "contact": {
      "name": "OneTrust Support",
      "url": "https://my.onetrust.com/s/contactsupport"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "description": "The Cookie Consent APIs are used to integrate external systems and streamline the flow of data with Cookie Consent in the OneTrust Platform."
  },
  "servers": [
    {
      "url": "https://{hostname}",
      "variables": {
        "hostname": {
          "default": "hostname",
          "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Scans",
      "description": "The Scans APIs are used to manage website cookie scanning operations and results.",
      "externalDocs": {
        "description": "OpenAPI 3.1.0 - Download Definition",
        "url": "https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"
      }
    }
  ],
  "x-onetrust": {
    "spec-label": "OpenAPI 3.1.0"
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "metrics-enabled": false
  },
  "paths": {
    "/api/cmp/v1/webscans/domains/{domainId}/scans": {
      "get": {
        "operationId": "getDomainScans",
        "summary": "Get List of Scans by Domain",
        "description": "Use this API to retrieve a list of scans for a specific domain and the specified filter criteria.",
        "tags": [
          "Scans"
        ],
        "x-onetrust": {
          "spec-label": "https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"
        },
        "parameters": [
          {
            "name": "domainId",
            "in": "path",
            "description": "The unique identifier of the domain.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          {
            "name": "status",
            "in": "query",
            "description": "The current state or condition of the item.",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "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"
              ]
            }
          },
          {
            "name": "archiveStatus",
            "in": "query",
            "description": "The archival state of the scan.",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "NONE",
                "PENDING_UI",
                "PENDING_SCHEDULED",
                "ARCHIVE_STARTED",
                "ARCHIVE_COMPLETED",
                "ARCHIVE_QUEUED",
                "ERROR",
                "NO_DATA_TO_EXPORT"
              ]
            }
          },
          {
            "name": "startDate",
            "in": "query",
            "description": "The beginning date for filtering or date range operations.",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            },
            "example": "2025-04-25"
          },
          {
            "name": "endDate",
            "in": "query",
            "description": "The ending date for filtering or date range operations.",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            },
            "example": "2025-04-25"
          },
          {
            "name": "page",
            "in": "query",
            "description": "The page number for pagination results, starting from 0.",
            "required": false,
            "schema": {
              "type": "integer",
              "example": 1,
              "default": 0,
              "minimum": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "The number of items to return per page.",
            "required": false,
            "schema": {
              "type": "integer",
              "example": 10,
              "default": 10,
              "maximum": 100,
              "minimum": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PageScanInformationResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "429": {
            "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).",
            "headers": {
              "Retry-After": {
                "schema": {
                  "description": "The number of seconds after which requests will be allowed again.",
                  "format": "int32"
                }
              },
              "ot-period": {
                "schema": {
                  "description": "The unit of time for which the rate limit applies",
                  "enum": [
                    "HOUR",
                    "MINUTE"
                  ]
                }
              },
              "ot-ratelimit-event-id": {
                "schema": {
                  "description": "The unique identifier for the rate-limiting event.",
                  "format": "uuid"
                }
              },
              "ot-request-made": {
                "schema": {
                  "description": "The number of requests made within the specified period.",
                  "format": "int32"
                }
              },
              "ot-requests-allowed": {
                "schema": {
                  "description": "The number of requests allowed within the specified period.",
                  "format": "int32"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "OAUTH2": [
              "COOKIE",
              "COOKIE_READ"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "PageableObject": {
        "type": "object",
        "properties": {
          "offset": {
            "description": "The starting position for paginated results.",
            "type": "integer",
            "format": "int64"
          },
          "sort": {
            "description": "The sorting configuration applied to the results.",
            "$ref": "#/components/schemas/SortObject"
          },
          "paged": {
            "description": "This flag indicates whether pagination is enabled.",
            "type": "boolean"
          },
          "pageSize": {
            "description": "The number of items displayed per page.",
            "type": "integer",
            "format": "int32"
          },
          "pageNumber": {
            "description": "The current page number in the pagination sequence.",
            "type": "integer",
            "format": "int32"
          },
          "unpaged": {
            "description": "This flag indicates whether pagination is disabled.",
            "type": "boolean"
          }
        }
      },
      "SortObject": {
        "type": "object",
        "properties": {
          "empty": {
            "description": "This flag indicates whether the result set is empty.",
            "type": "boolean"
          },
          "sorted": {
            "description": "This flag indicates whether the results are sorted.",
            "type": "boolean"
          },
          "unsorted": {
            "description": "This flag indicates whether the results are in unsorted order.",
            "type": "boolean"
          }
        }
      },
      "PageScanInformationResponse": {
        "type": "object",
        "properties": {
          "totalPages": {
            "description": "The total number of pages in the paginated results.",
            "type": "integer",
            "format": "int32"
          },
          "totalElements": {
            "description": "The total number of items in the complete result set.",
            "type": "integer",
            "format": "int64"
          },
          "size": {
            "description": "The number of items to return per page.",
            "type": "integer",
            "format": "int32"
          },
          "content": {
            "description": "The main content or data payload of the response.",
            "items": {
              "$ref": "#/components/schemas/ScanInformationResponse"
            },
            "type": "array"
          },
          "number": {
            "description": "The numeric value or identifier.",
            "type": "integer",
            "format": "int32"
          },
          "sort": {
            "description": "The sorting configuration applied to the results.",
            "$ref": "#/components/schemas/SortObject"
          },
          "pageable": {
            "description": "The pagination configuration settings.",
            "$ref": "#/components/schemas/PageableObject"
          },
          "first": {
            "description": "This flag indicates whether this is the first item in a sequence.",
            "type": "boolean"
          },
          "last": {
            "description": "This flag indicates whether this is the last item in a sequence.",
            "type": "boolean"
          },
          "numberOfElements": {
            "description": "The number of items in the current page.",
            "type": "integer",
            "format": "int32"
          },
          "empty": {
            "description": "This flag indicates whether the result set is empty.",
            "type": "boolean"
          }
        }
      },
      "ScanInformationResponse": {
        "type": "object",
        "properties": {
          "scanId": {
            "description": "The unique identifier of the scan.",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "domainId": {
            "description": "The unique identifier of the domain.",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "startingUrl": {
            "description": "The initial URL where the scanning process begins.",
            "type": "string",
            "example": "amazon.com",
            "maxLength": 500,
            "minLength": 1
          },
          "sequence": {
            "description": "The order or position in a sequential series.",
            "type": "integer",
            "format": "int32",
            "example": 3
          },
          "crawlStartDt": {
            "description": "The date and time when the crawling process started.",
            "type": "string",
            "format": "date-time",
            "example": "2025-04-01T12:34:32Z"
          },
          "crawlEndDt": {
            "description": "The date and time when the crawling process ended.",
            "type": "string",
            "format": "date-time",
            "example": "2025-04-01T12:34:32Z"
          },
          "usedQueryParameters": {
            "description": "The query parameters that were used during the scanning process.",
            "type": "string",
            "example": "language=en,region=on",
            "maxLength": 1000,
            "minLength": 1
          },
          "scanPageLimit": {
            "description": "The maximum number of pages allowed per scan operation.",
            "type": "integer",
            "format": "int32",
            "example": 1000
          },
          "pagesScanned": {
            "description": "The number of pages that were actually scanned.",
            "type": "integer",
            "format": "int32",
            "example": 155
          },
          "errorDescription": {
            "description": "The description of any error that occurred.",
            "type": "string",
            "example": "ABRUPT_SCAN_TERMINATION",
            "maxLength": 500,
            "minLength": 1
          },
          "cookieNotice": {
            "description": "The notice or information about cookie usage.",
            "type": "boolean",
            "example": true
          },
          "retryCount": {
            "description": "The number of times the operation was retried.",
            "type": "integer",
            "format": "int32",
            "example": 0
          },
          "totalPagesFound": {
            "description": "The total number of pages discovered during scanning.",
            "type": "integer",
            "format": "int32",
            "example": 255
          },
          "cookiesFound": {
            "description": "The number of cookies discovered during scanning.",
            "type": "integer",
            "format": "int32",
            "example": 132
          },
          "geoLocation": {
            "description": "The geographic location settings for the scan.",
            "type": "string",
            "example": "northeurope",
            "maxLength": 100,
            "minLength": 1
          },
          "limitScanToSitemap": {
            "description": "This flag indicates whether to restrict scanning to sitemap URLs only.",
            "type": "boolean",
            "example": false
          },
          "status": {
            "description": "The current state or condition of the item.",
            "type": "string",
            "example": "INPROGRESS",
            "enum": [
              "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"
            ]
          },
          "scanType": {
            "description": "The type or method of scanning being performed.",
            "type": "string",
            "example": "UI_SCAN",
            "enum": [
              "UI_SCAN",
              "SCHEDULE_SCAN"
            ]
          },
          "archiveStatus": {
            "description": "The archival state of the scan.",
            "type": "string",
            "example": "ARCHIVE_COMPLETED",
            "enum": [
              "NONE",
              "PENDING_UI",
              "PENDING_SCHEDULED",
              "ARCHIVE_STARTED",
              "ARCHIVE_COMPLETED",
              "ARCHIVE_QUEUED",
              "ERROR",
              "NO_DATA_TO_EXPORT"
            ]
          }
        }
      }
    },
    "securitySchemes": {
      "OAUTH2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://{hostname}/api/access/v1/oauth/token",
            "scopes": {
              "COOKIE": "Cookie Scope gives the user access to read/write operations inside the Cookie Consent module.",
              "COOKIE_READ": "Cookie Read Scope gives the user read-only access to the Cookie Consent module."
            }
          }
        }
      }
    }
  }
}
```