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

# List scans

> Lists scan runs across the workspace, newest first. Filter by `status` (`active` means queued, running, or paused) or by domain slug.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/scans
openapi: 3.1.0
info:
  title: ility API
  version: 1.0.0
  description: Read accessibility results and start scans in your ility workspace.
servers:
  - url: https://app.ilitylabs.com
security:
  - apiKey: []
tags:
  - name: Workspaces
  - name: Surfaces
  - name: Domains
  - name: Scans
  - name: Issues
paths:
  /v1/scans:
    get:
      tags:
        - Scans
      summary: List scans
      description: >-
        Lists scan runs across the workspace, newest first. Filter by `status`
        (`active` means queued, running, or paused) or by domain slug.
      parameters:
        - schema:
            type: string
            enum:
              - queued
              - running
              - paused
              - complete
              - failed
              - canceled
              - active
          required: false
          name: status
          in: query
        - schema:
            type: string
            minLength: 1
          required: false
          name: domain
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          required: false
          name: limit
          in: query
        - schema:
            type: string
          required: false
          name: cursor
          in: query
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanRunListItemCursorListResponse'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ScanRunListItemCursorListResponse:
      type: object
      properties:
        items:
          $ref: '#/components/schemas/ScanRunListItemListResponse'
        next_cursor:
          type:
            - string
            - 'null'
      required:
        - items
        - next_cursor
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
        reason:
          type: string
      required:
        - detail
    ScanRunListItemListResponse:
      type: array
      items:
        $ref: '#/components/schemas/ScanRunListItem'
    ScanRunListItem:
      allOf:
        - $ref: '#/components/schemas/ScanRun'
        - type: object
          properties:
            domain_slug:
              type: string
            domain_name:
              type: string
            group_id:
              type:
                - string
                - 'null'
              format: uuid
            surface_id:
              type:
                - string
                - 'null'
              format: uuid
            pages_complete:
              type: integer
              minimum: 0
            pages_total:
              type: integer
              minimum: 0
          required:
            - domain_slug
            - domain_name
            - group_id
            - surface_id
            - pages_complete
            - pages_total
    ScanRun:
      type: object
      properties:
        id:
          type: string
          format: uuid
        workspace_id:
          type: string
          format: uuid
        domain_id:
          type: string
          format: uuid
        engine_id:
          type: string
          format: uuid
        engine_slug:
          type: string
        scan_request_id:
          type: string
          format: uuid
        scope:
          type: string
        status:
          type: string
        trigger_source:
          type: string
        triggered_by_user_id:
          type:
            - string
            - 'null'
        config_snapshot:
          type: object
          additionalProperties: {}
        pages_scanned:
          type:
            - integer
            - 'null'
        pages_failed:
          type:
            - integer
            - 'null'
        issues_found:
          type:
            - integer
            - 'null'
        score:
          type:
            - integer
            - 'null'
        has_blocking:
          type: boolean
        error:
          type:
            - string
            - 'null'
        cancel_requested_at:
          type:
            - string
            - 'null'
          format: date-time
        pause_requested_at:
          type:
            - string
            - 'null'
          format: date-time
        paused_at:
          type:
            - string
            - 'null'
          format: date-time
        started_at:
          type:
            - string
            - 'null'
          format: date-time
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - workspace_id
        - domain_id
        - engine_id
        - engine_slug
        - scan_request_id
        - scope
        - status
        - trigger_source
        - triggered_by_user_id
        - config_snapshot
        - pages_scanned
        - pages_failed
        - issues_found
        - score
        - has_blocking
        - error
        - cancel_requested_at
        - pause_requested_at
        - paused_at
        - started_at
        - completed_at
        - created_at
        - updated_at
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An ility API key, such as `ilk_1a2b3c4d_…`. Workspace owners create keys
        under Settings → API keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.