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

# Exportar registros del objeto

> Exporta CSV seguro contra fórmulas para el objeto. Una exportación de un objeto personalizado sin search, en orden de created_at o updated_at, contiene como máximo 1,000 registros por respuesta. Vuelve a solicitar con next_cursor hasta que has_more sea false. Cada respuesta es un CSV completo con su propia fila de encabezado. Para exportar un rango de fechas, envía un filtro de created_at o updated_at en filters_json. Cualquier otra exportación lee la ventana del motor de 1,000 filas, responde has_more false y marca is_capped cuando quedan más filas.

**Scopes requeridos:** `data_objects.export`


## OpenAPI

````yaml /es/api-reference/openapi.yaml get /api/v1/objects/{object_id}/export
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/objects/{object_id}/export:
    get:
      tags:
        - Objects
      summary: Exportar registros del objeto
      description: >-
        Exporta CSV seguro contra fórmulas para el objeto. Una exportación de un
        objeto personalizado sin search, en orden de created_at o updated_at,
        contiene como máximo 1,000 registros por respuesta. Vuelve a solicitar
        con next_cursor hasta que has_more sea false. Cada respuesta es un CSV
        completo con su propia fila de encabezado. Para exportar un rango de
        fechas, envía un filtro de created_at o updated_at en filters_json.
        Cualquier otra exportación lee la ventana del motor de 1,000 filas,
        responde has_more false y marca is_capped cuando quedan más filas.
      operationId: Export object records
      parameters:
        - $ref: '#/components/parameters/ObjectId'
        - $ref: '#/components/parameters/Search'
        - $ref: '#/components/parameters/Cursor'
        - $ref: '#/components/parameters/ObjectViewId'
        - $ref: '#/components/parameters/ObjectFiltersJson'
        - $ref: '#/components/parameters/ObjectSortsJson'
      responses:
        '200':
          description: Payload de exportación CSV.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectExportResponse'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    ObjectId:
      name: object_id
      in: path
      required: true
      description: >-
        Id del objeto, clave de sistema como system:leads, o slug del
        descubrimiento.
      x-docs-test-value: system:leads
      schema:
        type: string
        minLength: 1
        maxLength: 200
    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
    ObjectViewId:
      name: view_id
      in: query
      schema:
        type: string
        maxLength: 200
    ObjectFiltersJson:
      name: filters_json
      in: query
      description: >-
        Texto JSON de un ObjectFilterQuery. Envía un array de filtros que deben
        coincidir todos, o un objeto con filters y un filtro avanzado cuyas
        reglas se unen con and u or. Cada filtro indica un campo en fieldId por
        su id o su clave, tal como los lista GET /api/v1/objects/{object_id}.
        Operadores: is_empty e is_not_empty no reciben value. equals,
        not_equals, contains y has_reached reciben value. any_of recibe un array
        de cadenas. greater_than y less_than reciben un número, y between recibe
        value y valueTo. before y after reciben una fecha (YYYY-MM-DD) o una
        fecha/hora ISO 8601 y excluyen el día que indican. within_range recibe
        value y valueTo e incluye ambos días. Una fecha sola cubre todo el día
        UTC. Una fecha/hora con desfase se convierte a UTC. Sin filters_json, la
        lectura aplica los filtros de view_id, o ninguno. Un JSON inválido, un
        operador desconocido, un value faltante, un campo desconocido o un campo
        que no se puede filtrar devuelve 400 con la ruta de cada problema.
        Ejemplo, registros creados en octubre de 2026:
        [{"fieldId":"created_at","operator":"within_range","value":"2026-10-01","valueTo":"2026-10-31"}]
      schema:
        type: string
        maxLength: 20000
        contentMediaType: application/json
        contentSchema:
          $ref: '#/components/schemas/ObjectFilterQuery'
    ObjectSortsJson:
      name: sorts_json
      in: query
      description: >-
        Texto JSON de un array de ObjectSort. Cada orden indica un campo en
        fieldId por su id o su clave. Sin sorts_json, la lectura usa el orden de
        view_id, o created_at, del más reciente al más antiguo. Solo un único
        orden por created_at o updated_at conserva el cursor keyset. Cualquier
        otro orden pagina por número. Un JSON inválido, un campo desconocido o
        un campo de fórmula devuelve 400. Ejemplo, registros más antiguos
        primero: [{"fieldId":"created_at","direction":"asc"}]
      schema:
        type: string
        maxLength: 20000
        contentMediaType: application/json
        contentSchema:
          type: array
          maxItems: 5
          items:
            $ref: '#/components/schemas/ObjectSort'
  schemas:
    ObjectExportResponse:
      type: object
      additionalProperties: false
      required:
        - filename
        - csv
        - record_count
        - is_capped
        - next_cursor
        - has_more
      properties:
        filename:
          type: string
        csv:
          type: string
        record_count:
          type: integer
        is_capped:
          type: boolean
        next_cursor:
          type:
            - string
            - 'null'
          description: >-
            Cursor para la siguiente respuesta de exportación, o null en la
            última.
        has_more:
          type: boolean
          description: >-
            true mientras siguen más registros. Vuelve a solicitar con
            next_cursor.
        total:
          type: integer
          minimum: 0
          description: >-
            Cantidad exacta de registros que coinciden con la exportación.
            Algunas exportaciones 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
    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
    NotFound:
      description: Recurso no encontrado en el workspace vinculado a la key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    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'
  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
    RetryAfter:
      description: Segundos hasta que el llamador debería reintentar.
      schema:
        type: string
  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.