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

# Listar reportes

> Lista reportes de medición activos para sincronización incremental de socios.

**Scopes requeridos:** `reports.read`


## OpenAPI

````yaml /es/api-reference/openapi.yaml get /api/v1/reports
openapi: 3.1.0
info:
  title: RoofKit Partner API
  version: 1.0.0
  summary: API REST JSON para integraciones externas de socios de RoofKit.
  contact:
    name: RoofKit Engineering
  description: >-
    RoofKit Partner API v1 autentica solicitudes con API keys del workspace. Las
    API keys vinculan cada solicitud exactamente a un workspace; las rutas de
    Partner API no aceptan roofer_id, workspace_id ni identificadores de tenant.
    Los endpoints autenticados están limitados a 60 solicitudes por minuto por
    API key, método y plantilla de ruta; los intentos de autenticación inválidos
    se limitan por separado a 20 solicitudes por minuto por cliente y endpoint.
    Los parámetros y campos de fecha/hora aceptan ISO 8601 con Z o un desfase
    ±HH:MM, por ejemplo 2026-09-07T04:00:00Z o 2026-09-07T00:00:00-04:00. Ambos
    indican el mismo instante y devuelven el mismo resultado. Codifica + como
    %2B en una query string. Las respuestas usan UTC.


    Una fecha/hora sin desfase, por ejemplo 2026-09-07T04:00:00, está obsoleta.
    Hasta la fecha de retiro, 2027-01-10T00:00:00Z, se interpreta como UTC, y la
    respuesta incluye un header `Deprecation` (RFC 9745) y un header `Sunset`
    (RFC 8594). A partir de la fecha de retiro, se requiere Z o un desfase
    ±HH:MM. Desde entonces, una fecha/hora sin desfase devuelve 400 con el
    código `VALIDATION_ERROR`, y la respuesta no incluye ningún header
    `Deprecation` ni `Sunset`.


    Cada API key tiene solo los scopes que un propietario o administrador del
    workspace eligió al crear la key, y sus scopes nunca cambian. Cada operación
    indica los scopes que requiere en `x-required-scopes`. Una key nueva en
    Configuración empieza con el nivel predefinido Solo lectura: `leads.read`,
    `analytics.read`, `reports.read` y `data_objects.read`. Una key de Solo
    lectura puede llamar a todas las operaciones de lectura excepto las
    exportaciones, las lecturas de Sales Visualizer y los Data Objects en
    papelera, y no puede llamar a ninguna operación de escritura. Una llamada
    que necesita un scope que la key no tiene devuelve 403 `FORBIDDEN`, y
    `error.details.required_scope` indica un scope faltante.
servers:
  - url: https://api.roofkit.ai
    description: Origen canónico de RoofKit Partner API
security:
  - ApiKeyBearer: []
tags:
  - name: Foundation
    description: Endpoints base de autenticación y contrato.
  - name: Leads
    description: Endpoints de sincronización de leads para CRM de socios.
  - name: Attribution
    description: >-
      Endpoints de atribución de marketing, analíticas de campañas e ingesta de
      eventos para socios.
  - name: Pipeline
    description: Metadatos del pipeline de leads legibles para socios.
  - name: Reports
    description: >-
      Endpoints para importar, listar, obtener, exportar y descargar reportes de
      socios.
  - name: Visualizer
    description: >-
      Endpoints de Partner para crear Sales Visualizer, generar visualizaciones,
      crear enlaces alojados de subida de fotos, leer imágenes, consultar el
      historial de sesión y crear enlaces compartidos.
  - name: Estimates
    description: >-
      Creación y lectura de Budget Estimates de Partner para el workspace
      vinculado a la key.
  - name: Objects
    description: >-
      Endpoints de Partner para descubrimiento, esquema, registros, relaciones,
      vistas y administración de Data Objects.
paths:
  /api/v1/reports:
    get:
      tags:
        - Reports
      summary: Listar reportes
      description: >-
        Lista reportes de medición activos para sincronización incremental de
        socios.
      operationId: List reports
      parameters:
        - $ref: '#/components/parameters/UpdatedFrom'
        - $ref: '#/components/parameters/UpdatedTo'
        - $ref: '#/components/parameters/ReportStatus'
        - $ref: '#/components/parameters/Search'
        - $ref: '#/components/parameters/Cursor'
        - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: Página de reportes activos.
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            Sunset:
              $ref: '#/components/headers/Sunset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportListResponse'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    UpdatedFrom:
      name: from
      in: query
      description: >-
        Límite inferior inclusivo de updated_at para sincronización incremental.
        Fecha/hora ISO 8601 con Z o un desfase ±HH:MM. Codifica + como %2B.
      schema:
        type: string
        format: date-time
    UpdatedTo:
      name: to
      in: query
      description: >-
        Límite superior inclusivo de updated_at para sincronización incremental.
        Fecha/hora ISO 8601 con Z o un desfase ±HH:MM. Codifica + como %2B.
      schema:
        type: string
        format: date-time
    ReportStatus:
      name: status
      in: query
      schema:
        type: string
        enum:
          - draft
          - needs_review
          - approved
          - failed
    Search:
      name: search
      in: query
      schema:
        type: string
        maxLength: 200
    Cursor:
      name: cursor
      in: query
      description: >-
        Cursor opaco devuelto por respuestas de listado/exportación. Envíalo de
        vuelta sin cambios; los cursores malformados devuelven 400.
      schema:
        type: string
        maxLength: 500
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
  headers:
    RateLimitLimit:
      description: Cantidad máxima de solicitudes permitidas en la ventana actual.
      schema:
        type: string
    RateLimitRemaining:
      description: Solicitudes restantes en la ventana actual.
      schema:
        type: string
    RateLimitReset:
      description: Timestamp ISO cuando se reinicia la ventana actual de rate limit.
      schema:
        type: string
        format: date-time
    Deprecation:
      description: >-
        Presente solo cuando la solicitud envió una fecha/hora sin desfase
        respecto a UTC. Esa forma está obsoleta y se interpretó como UTC. El
        valor es la fecha de obsolescencia de RFC 9745 como `@` seguido de los
        segundos Unix.
      schema:
        type: string
        example: '@1791763200'
    Sunset:
      description: >-
        Presente solo con Deprecation. La HTTP-date de RFC 8594 a partir de la
        cual una fecha/hora sin desfase respecto a UTC devuelve 400.
      schema:
        type: string
        example: Sun, 10 Jan 2027 00:00:00 GMT
    RetryAfter:
      description: Segundos hasta que el llamador debería reintentar.
      schema:
        type: string
  schemas:
    ReportListResponse:
      type: object
      additionalProperties: false
      required:
        - reports
        - pagination
      properties:
        reports:
          type: array
          items:
            $ref: '#/components/schemas/Report'
        pagination:
          $ref: '#/components/schemas/CursorPagination'
    Report:
      type: object
      additionalProperties: false
      required:
        - id
        - project_name
        - external_report_id
        - status
        - current_revision_id
        - baseline_revision_id
        - approved_revision_id
        - source_formats
        - summary
        - current_revision_number
        - project_address
        - location_label
        - location_lat
        - location_long
        - created_at
        - updated_at
      properties:
        id:
          type: string
        project_name:
          type: string
        external_report_id:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/ReportStatus'
        current_revision_id:
          type:
            - string
            - 'null'
        baseline_revision_id:
          type:
            - string
            - 'null'
        approved_revision_id:
          type:
            - string
            - 'null'
        source_formats:
          type: array
          items:
            $ref: '#/components/schemas/ReportArtifactFormat'
        summary:
          type: object
          additionalProperties: true
        current_revision_number:
          type:
            - integer
            - 'null'
        project_address:
          type:
            - string
            - 'null'
        location_label:
          type:
            - string
            - 'null'
        location_lat:
          type:
            - number
            - 'null'
        location_long:
          type:
            - number
            - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    CursorPagination:
      type: object
      additionalProperties: false
      required:
        - limit
        - next_cursor
        - has_more
      properties:
        limit:
          type: integer
          minimum: 1
          maximum: 10000
        next_cursor:
          type:
            - string
            - 'null'
        has_more:
          type: boolean
        total:
          type: integer
          minimum: 0
          description: >-
            Cantidad exacta de filas que coinciden con la solicitud. Algunas
            lecturas la incluyen y otras no, así que trátala como opcional.
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - message
            - request_id
          properties:
            code:
              $ref: '#/components/schemas/ErrorCode'
            message:
              type: string
            request_id:
              type: string
            details:
              type: object
              additionalProperties: true
    ReportStatus:
      type: string
      enum:
        - importing
        - needs_review
        - draft
        - ready_for_review
        - approved
        - exporting
        - failed
        - archived
    ReportArtifactFormat:
      type: string
      enum:
        - xml
        - csv
        - xlsx
        - dxf
        - pdf
        - json
        - zip
        - manifest
        - tif
        - png
        - jpg
        - jpeg
        - webp
        - gif
    ErrorCode:
      type: string
      enum:
        - UNAUTHORIZED
        - FORBIDDEN
        - RATE_LIMITED
        - VALIDATION_ERROR
        - NOT_FOUND
        - CONFLICT
        - INSUFFICIENT_CREDITS
        - INTERNAL_ERROR
  responses:
    ValidationError:
      description: El payload, query o header requerido de la solicitud no es válido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: API key ausente, malformada, revocada, eliminada o desconocida.
      headers:
        WWW-Authenticate:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >-
        La API key no tiene un scope requerido, o el workspace no está activo.
        Un fallo de scope indica un scope faltante en `details.required_scope`.
        Cuando la búsqueda de la key rechaza la llamada,
        `details.missing_scopes` lista cada scope requerido que la key no tiene.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missing_scope:
              summary: Una key de Solo lectura llama a una operación de escritura
              value:
                error:
                  code: FORBIDDEN
                  message: 'API key does not include the required scope: leads.write.'
                  request_id: req_123
                  details:
                    required_scope: leads.write
                    missing_scopes:
                      - leads.write
    RateLimited:
      description: >-
        Rate limit excedido para esta key y endpoint o para el bucket de
        autenticación inválida.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Error interno de autenticación o del servidor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: RoofKit API key
      description: 'Usa `Authorization: Bearer rk_live_...`.'

````

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