Skip to main content

Export Record Set

Export a complete record set as a downloadable file. Returns all records with their cell values in a single response for bulk consumption.

Export the complete contents of a record set as a downloadable payload. Unlike the paginated records endpoint, this returns all records in a single response, making it suitable for bulk data consumption, ETL pipelines, and offline analysis. The export includes all cell values for every record in the set.

The export endpoint streams the full record set content without pagination. For large record sets, this may result in significant response payloads. Consider using the paginated records endpoint for interactive use cases, and reserve this endpoint for batch export workflows where you need the complete dataset in one call.

GET/v1/record-sets/{id}/export

Response

Response fields

dataarrayComplete array of record objects with cells.
fieldsarrayArray of field definitions for column ordering.
record_countintegerTotal number of exported records.
exported_atstringISO 8601 timestamp of the export.

curl

Response

{
  "data": [
    {
      "id": "rec-f1e2d3c4-b5a6-7890-fedc-ba0987654321",
      "document_id": "doc-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cells": {
        "invoice_number": { "value": "INV-2024-0042", "confidence": 0.97 },
        "country_code": { "value": "DE", "confidence": 0.95 }
      }
    }
  ],
  "fields": [
    { "field_key": "invoice_number", "type": "string", "ordinal": 0 },
    { "field_key": "country_code", "type": "string", "ordinal": 1 }
  ],
  "record_count": 142,
  "exported_at": "2024-10-16T09:00:00.000Z"
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundRecord set not found or does not belong to your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

List Record Set Records
Extractions
Jobs
Resolutions