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

# Get Scan Report

> Retrieve a scan report in HTML, SARIF, Markdown, or PDF format. PDF reports are available after a scan completes, including scans with no findings. format=pdf accepts only urgency and classification filters; other filters return 400. Reports with more than 500 findings are generated asynchronously and return 202 with a poll_url that includes a job parameter. Poll the same endpoint with format=pdf and job until the PDF is ready.



## OpenAPI

````yaml /api-reference/openapi.json get /scan/{scan_id}/report
openapi: 3.0.0
info:
  title: Corgea API
  version: 1.0.0
  description: >-
    API for interacting with Corgea's scanning and vulnerability management
    features
servers:
  - url: https://www.corgea.app/api/v1
    description: Production server
security:
  - CorgeaToken: []
  - BearerAuth: []
paths:
  /scan/{scan_id}/report:
    get:
      tags:
        - Scans
        - Reports
      summary: Get Scan Report
      description: >-
        Retrieve a scan report in HTML, SARIF, Markdown, or PDF format. PDF
        reports are available after a scan completes, including scans with no
        findings. format=pdf accepts only urgency and classification filters;
        other filters return 400. Reports with more than 500 findings are
        generated asynchronously and return 202 with a poll_url that includes a
        job parameter. Poll the same endpoint with format=pdf and job until the
        PDF is ready.
      operationId: getScanReport
      parameters:
        - name: scan_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: The ID of the scan
        - name: format
          in: query
          required: false
          schema:
            type: string
            enum:
              - sarif
              - html
              - markdown
              - pdf
            default: sarif
          description: Report format (html, sarif, markdown, or pdf)
        - name: view
          in: query
          required: false
          schema:
            type: string
            default: cwe
          description: View type for HTML reports
        - name: urgency
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - CR
                - HI
                - ME
                - LO
          style: form
          explode: true
          description: Repeatable urgency filter. PDF reports accept CR, HI, ME, and LO.
        - name: classification
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          description: >-
            Repeatable finding classification filter for PDF reports. Matching
            is case-insensitive and accepts prefixes such as CWE-79.
        - name: job
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: >-
            PDF export job ID returned in a 202 response. Poll the same endpoint
            with format=pdf and this job value until the report is ready.
      responses:
        '200':
          description: Report retrieved successfully
          content:
            application/json:
              schema:
                description: SARIF report when format=sarif
                type: object
            text/html:
              schema:
                type: string
                description: HTML report when format=html
            text/markdown:
              schema:
                type: string
                description: >-
                  Markdown report when format=markdown. Issue entries include
                  the issue assignee when available.
            application/pdf:
              schema:
                type: string
                format: binary
                description: Branded scan report when format=pdf
          headers:
            Content-Disposition:
              description: Filename for downloadable report formats
              schema:
                type: string
        '202':
          description: >-
            PDF report generation is in progress. Retry the poll_url after the
            number of seconds in Retry-After.
          headers:
            Retry-After:
              schema:
                type: integer
                example: 5
              description: Seconds to wait before polling again
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: generating
                  job_id:
                    type: string
                  findings:
                    type: integer
                    description: Number of findings; returned when generation starts
                  poll_url:
                    type: string
                    description: URL to poll; returned when generation starts
                  retry_after_seconds:
                    type: integer
                    example: 5
        '400':
          description: >-
            PDF report is unavailable while the scan is running, or a filter is
            empty, unknown, or unsupported
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Permission denied
        '404':
          description: Scan not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: Scan not found
        '500':
          description: Report generation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: >-
                      SARIF export failed. Please try again later or contact
                      support.
components:
  securitySchemes:
    CorgeaToken:
      type: apiKey
      in: header
      name: CORGEA-TOKEN
      description: API key for authentication
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth2 access token (JWT) in the Authorization header

````