> ## 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.

# Obtener escaneos

> Obtiene una lista de escaneos de la empresa del usuario autenticado



## OpenAPI

````yaml /es/api-reference/openapi.json get /scans
openapi: 3.0.0
info:
  title: API de Corgea
  version: 1.0.0
  description: >-
    API para interactuar con las funciones de escaneo y gestión de
    vulnerabilidades de Corgea
servers:
  - url: https://www.corgea.app/api/v1
    description: Servidor de producción
security:
  - CorgeaToken: []
  - BearerAuth: []
paths:
  /scans:
    get:
      tags:
        - Escaneos
      summary: Obtener escaneos
      description: Obtiene una lista de escaneos de la empresa del usuario autenticado
      operationId: getScans
      parameters:
        - name: project
          in: query
          required: false
          schema:
            type: string
          description: Filtra los escaneos por nombre de proyecto
        - name: repo
          in: query
          required: false
          schema:
            type: string
          description: Filtra los escaneos por una subcadena de la URL del repositorio
        - name: branch
          in: query
          required: false
          schema:
            type: string
          description: Filtra los escaneos por el nombre exacto de la rama
        - name: pull_request_id
          in: query
          required: false
          schema:
            type: string
          description: >-
            Filtra los escaneos por el identificador exacto del pull request o
            merge request
        - name: sha
          in: query
          required: false
          schema:
            type: string
          description: Filtra los escaneos por el SHA exacto del commit
        - name: triggered_by
          in: query
          required: false
          schema:
            type: string
          description: >-
            Filtra los escaneos por el usuario que los inició. Utiliza una
            dirección de correo electrónico o "current_user".
        - name: scan_type
          in: query
          required: false
          schema:
            type: string
            enum:
              - full
              - partial
          description: >-
            Filtra los escaneos por tipo. Utiliza "full" para escaneos completos
            o "partial" para escaneos limitados a los archivos seleccionados.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
          description: Número de página de la paginación
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            default: 20
            maximum: 50
          description: Número de resultados por página
      responses:
        '200':
          description: Escaneos obtenidos correctamente
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
                  page:
                    type: integer
                  total_pages:
                    type: integer
                  total_scans:
                    type: integer
                    description: >-
                      Número total de escaneos que coinciden con la solicitud en
                      todas las páginas
                  scans:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        engine:
                          type: string
                          example: corgea
                        project:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                        repo:
                          type: string
                        branch:
                          type: string
                        status:
                          type: string
                          enum:
                            - scanning
                            - processing
                            - complete
                            - incomplete
                          description: >-
                            Progreso del escaneo. "scanning" y "processing" son
                            estados en curso, "complete" indica que el escaneo
                            ha terminado e "incomplete" indica que ha fallado.
                        pull_request_id:
                          type: string
                          nullable: true
                        git_sha:
                          type: string
                          nullable: true
                          description: SHA del commit asociado al escaneo
                        metadata:
                          type: object
                          nullable: true
                          additionalProperties: true
                          description: >-
                            Metadatos proporcionados por el usuario y asociados
                            al escaneo
        '403':
          description: Permiso denegado
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Permission denied
components:
  securitySchemes:
    CorgeaToken:
      type: apiKey
      in: header
      name: CORGEA-TOKEN
      description: Clave de API para la autenticación
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token de acceso OAuth2 (JWT) en el encabezado Authorization

````