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

# List Scans

> Lists the Site’s Scan history, newest first. Use createdAt and completedAt to check cadence and data freshness.



## OpenAPI

````yaml /openapi/public-api-v1.json get /v1/sites/{siteId}/scans
openapi: 3.0.0
info:
  title: Onsomble API
  description: >-
    Connect Onsomble to your reporting and operational workflows. Read
    discoverability results or start a Scan from another system.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.onsomble.ai
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: Sites
    description: Sites connected to your account.
  - name: Clients
    description: Clients managed by agency accounts.
  - name: Scans
    description: Scan history, status, and controls.
  - name: Reports
    description: AI discoverability results.
paths:
  /v1/sites/{siteId}/scans:
    get:
      tags:
        - Scans
      summary: List Scans
      description: >-
        Lists the Site’s Scan history, newest first. Use createdAt and
        completedAt to check cadence and data freshness.
      operationId: listScans
      parameters:
        - name: siteId
          required: true
          in: path
          schema:
            type: string
        - name: cursor
          required: false
          in: query
          description: Opaque cursor from the previous page. Omit for the first page.
          schema:
            type: string
        - name: limit
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListScansResponseDto'
        '404':
          description: Site not found.
components:
  schemas:
    ListScansResponseDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ScanDto'
        nextCursor:
          type: string
          nullable: true
          description: Opaque cursor for the next page, or null at the end.
      required:
        - data
        - nextCursor
    ScanDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - queued
            - running
            - completed
            - failed
          example: completed
        createdAt:
          type: string
          example: '2026-07-01T09:30:00.000Z'
        startedAt:
          type: string
          format: date-time
          nullable: true
          example: '2026-07-01T09:31:00.000Z'
        completedAt:
          type: string
          format: date-time
          nullable: true
          example: '2026-07-01T09:42:00.000Z'
          description: >-
            When the Scan reached a terminal state. Null while it is queued or
            running.
        updatedAt:
          type: string
          example: '2026-07-01T09:42:00.000Z'
      required:
        - id
        - status
        - createdAt
        - startedAt
        - completedAt
        - updatedAt
  securitySchemes:
    apiKeyAuth:
      scheme: bearer
      bearerFormat: ons_…
      type: http
      description: An API key created in Settings → Account → API Keys.

````