Tinvio Export Search Records API

Export search results from any entity table as a downloadable XLSX file. Apply the same filters used in table views, preview record counts, and discover available columns per entity type.

Operations 3

POST /api/v1/export-records Export Filtered Records #
GET /api/v1/export-records/columns/{entityType} Get Exportable Columns #
POST /api/v1/export-records/preview Preview Export Records #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/tinvio-com:tinvio-com-export-search-records-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

tinvio-com-export-search-records-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Tinvio Com Export Search Records API
  version: '1.0'
  contact:
    email: build.with@jaz.ai
    name: API Support
    url: https://jaz.ai
  description: 'Operations tagged Export Search Records across 2 of this provider''s published API definitions: tinvio-com-openapi-original.yaml, tinvio-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.getjaz.com
tags:
- description: Export search results from any entity table as a downloadable XLSX file. Apply the same filters used in table views, preview record counts, and discover available columns per entity type.
  name: Export Search Records
paths:
  /api/v1/export-records:
    post:
      description: Export filtered records for an entity type to a downloadable XLSX file. Returns a presigned S3 URL for download.
      operationId: create-export-record
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Export Filtered Records
      tags:
      - Export Search Records
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportFilteredSearchClientRequest'
        description: The export request request.
        required: true
    servers:
    - url: https://api.getjaz.com
  /api/v1/export-records/columns/{entityType}:
    get:
      description: Get the list of columns available for export for a given entity type, including default column indicators.
      operationId: get-export-record-column
      parameters:
      - description: Entity type to retrieve available columns for.
        in: path
        name: entityType
        required: true
        schema:
          type: string
          enum:
          - INVOICE
          - BILL
          - CUSTOMER_CREDIT_NOTE
          - SUPPLIER_CREDIT_NOTE
          - SALE_PAYMENT
          - PURCHASE_PAYMENT
          - BATCH_PAYMENT
          - CONTACT
          - ITEM
          - CAPSULE
          - SCHEDULED_TRANSACTION
          - JOURNAL
          - BANK_RECORD
          - CASHFLOW_TRANSACTION
          - FIXED_ASSET
          - CHART_OF_ACCOUNT
          - TAX_PROFILE
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Get Exportable Columns
      tags:
      - Export Search Records
    servers:
    - url: https://api.getjaz.com
  /api/v1/export-records/preview:
    post:
      description: Preview the results of an export without generating a file. Returns record count, preview rows, resolved columns, and warnings.
      operationId: create-export-record-preview
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Preview Export Records
      tags:
      - Export Search Records
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportFilteredSearchClientRequest'
        description: The preview request request.
        required: true
    servers:
    - url: https://api.getjaz.com
components:
  schemas:
    ErrorResponse:
      properties:
        error:
          allOf:
          - $ref: '#/components/schemas/ErrorResponseData'
          description: Error details.
      type: object
    ExportFilteredSearchClientRequest:
      properties:
        columns:
          description: Column definitions to include in the export (omit to use defaults).
          items:
            $ref: '#/components/schemas/ExportColumnClientInput'
          type: array
        entityType:
          description: Type of entity to export (e.g., INVOICE, BILL, CONTACT).
          enum:
          - INVOICE
          - BILL
          - CUSTOMER_CREDIT_NOTE
          - SUPPLIER_CREDIT_NOTE
          - SALE_PAYMENT
          - PURCHASE_PAYMENT
          - BATCH_PAYMENT
          - CONTACT
          - ITEM
          - CAPSULE
          - SCHEDULED_TRANSACTION
          - JOURNAL
          - BANK_RECORD
          - CASHFLOW_TRANSACTION
          - FIXED_ASSET
          - CHART_OF_ACCOUNT
          - TAX_PROFILE
          type: string
        filter:
          description: JSON filter object matching the same structure used by entity search endpoints (e.g., {"status":{"eq":"UNPAID"},"balanceAmount":{"gte":500}}). Supports operators like eq, neq, gt, gte, lt, lte, in, contains, between. Mutually exclusive with the query field.
          items:
            type: integer
          type: array
        outputFormat:
          description: Output file format.
          enum:
          - XLSX
          type: string
        query:
          description: Free-text search query using structured syntax. Supports status (status:unpaid), amount ($500+), date (date:this month), contact (customer:sakura), and sort (sort:date:desc). Combine multiple filters in one string (e.g., "status:unpaid $500+ date:this month"). Mutually exclusive with the filter field.
          example: status:unpaid $500+ date:this month
          maxLength: 1000
          type: string
        sort:
          allOf:
          - $ref: '#/components/schemas/ExportSortClientInput'
          description: Sort configuration for the exported records.
      required:
      - entityType
      - outputFormat
      type: object
    BaseResponse:
      properties:
        data:
          description: The response object.
      type: object
    ExportSortClientInput:
      properties:
        direction:
          description: Sort direction, ASC or DESC.
          enum:
          - ASC
          - DESC
          type: string
        field:
          description: Field path to sort by.
          example: valueDate
          type: string
      required:
      - direction
      - field
      type: object
    ExportColumnClientInput:
      properties:
        header:
          description: Column header label in the exported file.
          example: 'Invoice Ref #'
          type: string
        path:
          description: Database column path.
          example: s.reference
          type: string
        type:
          description: Data type hint for the column (affects formatting in the export).
          enum:
          - STRING
          - NUMBER
          - CURRENCY
          - DATE
          - BOOLEAN
          type: string
      required:
      - header
      - path
      type: object
    ErrorResponseData:
      properties:
        error_type:
          description: Error category, for example validation_error, invalid_request_body, or internal_server_error.
          example: validation_error
          type: string
        errors:
          description: Error messages describing what went wrong.
          items:
            type: string
          type: array
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Organization API key. Pass it in the x-jk-api-key header on every request.
      in: header
      name: x-jk-api-key
      type: apiKey
x-refined-from:
- tinvio-com-openapi-original.yaml
- tinvio-com-openapi.yml