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

# List scans

> Returns a paginated list of scans for the authenticated organization.



## OpenAPI

````yaml /openapi.json get /scans
openapi: 3.1.0
info:
  title: Strix API
  version: 1.0.0
  description: >-
    Public REST API for the Strix autonomous penetration testing platform.
    Manage scans, vulnerabilities, assets, schedules, API tokens, and webhooks.
servers:
  - url: /api/v1
    description: Strix v1 API
security:
  - BearerAuth: []
tags:
  - name: Scans
    description: Launch, monitor, and manage security scans.
  - name: Vulnerabilities
    description: View and triage discovered vulnerabilities.
  - name: Assets
    description: Domains and repositories registered for scanning.
  - name: Schedules
    description: Recurring scan schedules (Pro plan).
  - name: Tokens
    description: Manage API tokens for authentication.
  - name: Webhooks
    description: Configure webhook subscriptions for real-time event notifications.
  - name: Organization
    description: Workspace configuration for the authenticated organization.
  - name: Members
    description: Manage organization members and roles.
  - name: Invitations
    description: List and revoke organization invitations.
  - name: PR Reviews
    description: Automated security review of pull requests.
  - name: Connectors
    description: Network connectors for scanning internal/private targets.
  - name: Knowledge
    description: >-
      Organization knowledge base: documents, policies, and repo profiles that
      steer the agent.
  - name: Uploads
    description: Upload source/code/documentation archives for whitebox scans.
  - name: Integrations
    description: Third-party integrations (GitLab, Bitbucket, ticketing).
  - name: Chat
    description: Conversational agent sessions.
  - name: Analytics
    description: Aggregate dashboard analytics.
  - name: Test Users
    description: >-
      Per-domain test accounts (with optional MFA) the agent authenticates as
      during scans.
paths:
  /scans:
    get:
      tags:
        - Scans
      summary: List scans
      description: Returns a paginated list of scans for the authenticated organization.
      operationId: listScans
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - name: status
          in: query
          schema:
            $ref: '#/components/schemas/ScanStatus'
        - name: scan_type
          in: query
          schema:
            type: string
            enum:
              - whitebox
              - blackbox
        - name: date_from
          in: query
          description: Filter scans created on or after this date (ISO 8601).
          schema:
            type: string
            format: date-time
        - name: date_to
          in: query
          description: Filter scans created on or before this date (inclusive, end-of-day).
          schema:
            type: string
            format: date-time
        - name: domain_id
          in: query
          schema:
            type: string
            format: uuid
        - name: repository_id
          in: query
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/SortBy_CreatedAt'
        - $ref: '#/components/parameters/SortOrder'
      responses:
        '200':
          description: Paginated list of scans.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PaginatedResponse_Scan'
                  - type: object
                    properties:
                      scansThisMonth:
                        type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth:
            - scans:read
components:
  parameters:
    Page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    SortBy_CreatedAt:
      name: sort_by
      in: query
      schema:
        type: string
        enum:
          - created_at
        default: created_at
    SortOrder:
      name: sort_order
      in: query
      schema:
        type: string
        enum:
          - asc
          - desc
        default: desc
  schemas:
    ScanStatus:
      type: string
      enum:
        - pending
        - running
        - completed
        - failed
        - cancelled
    PaginatedResponse_Scan:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Scan'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
      required:
        - items
        - meta
    Scan:
      type: object
      properties:
        id:
          type: string
          format: uuid
        user_id:
          type: string
        title:
          type: string
        urls:
          type: array
          items:
            type: string
        repositories:
          type: array
          items:
            $ref: '#/components/schemas/Repository'
        domain_ids:
          type: array
          items:
            type: string
            format: uuid
        repository_ids:
          type: array
          items:
            type: string
            format: uuid
        schedule_id:
          type:
            - string
            - 'null'
        scan_type:
          type: string
          enum:
            - whitebox
            - blackbox
        connector_id:
          type:
            - string
            - 'null'
        is_retest:
          type: boolean
        status:
          $ref: '#/components/schemas/ScanStatus'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
        duration:
          type:
            - string
            - 'null'
        executive_summary:
          type: string
        methodology:
          type: string
        technical_analysis:
          type: string
        recommendations:
          type: string
        findings:
          $ref: '#/components/schemas/ScanFindings'
        org_knowledge_enabled:
          type:
            - boolean
            - 'null'
        live_prompt_enabled:
          type: boolean
        live_prompt_ready:
          type: boolean
      required:
        - id
        - user_id
        - title
        - status
        - created_at
    PaginationMeta:
      type: object
      properties:
        page:
          type: integer
        limit:
          type: integer
        total_items:
          type: integer
        total_pages:
          type: integer
        has_next:
          type: boolean
        has_prev:
          type: boolean
      required:
        - page
        - limit
        - total_items
        - total_pages
        - has_next
        - has_prev
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
    Repository:
      type: object
      properties:
        url:
          type: string
        branch:
          type: string
        provider:
          type: string
      required:
        - url
        - branch
        - provider
    ScanFindings:
      type: object
      properties:
        total:
          type: integer
        critical:
          type: integer
        high:
          type: integer
        medium:
          type: integer
        low:
          type: integer
      required:
        - total
        - critical
        - high
        - medium
        - low
  responses:
    Unauthorized:
      description: Missing or invalid API token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Insufficient permissions or missing scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API token obtained from the Tokens endpoint. Include as `Authorization:
        Bearer <token>`.

````