Skip to main content

Rows & Export

Paginate through reference data rows or download the entire table as a CSV file. Use rows for programmatic access and CSV export for spreadsheet workflows.

Access the row-level content of a reference data table. The rows endpoint returns paginated results with each row's data fields, while the CSV export endpoint downloads the entire table as a text/csv file suitable for spreadsheet applications.

Use the rows endpoint for programmatic access — for example, to verify that uploaded data matches expectations before running a matching config, or to build a preview in your integration. Pagination defaults to 100 rows per page with a maximum of 500. Each row includes an id field alongside the original data columns.

The CSV export endpoint returns the full table contents as a downloadable file with a Content-Disposition header set to attachment. Column headers match the column names from the table schema. This is useful for auditing reference data, sharing with non-technical stakeholders, or re-importing into external systems.

Both endpoints require read scope. For large tables, prefer the paginated rows endpoint over CSV export to avoid timeouts and memory pressure. The CSV export streams the response, but very large tables (50K+ rows) may be slow over high-latency connections.

The CSV export endpoint returns Content-Type: text/csv with a Content-Disposition: attachment header. Most HTTP clients will save this as a file automatically. Use the Accept header if your client needs content negotiation.
GET/v1/reference-data/:id/rows

Response (Rows)

Response fields

dataarrayArray of row objects with id and data fields.
data[].idstringRow UUID.
pagination.pageintegerCurrent page number.
pagination.limitintegerRows per page.
pagination.totalintegerTotal number of rows in the table.

cURL — Get rows

Response (Rows)

{
  "data": [
    {
      "id": "row_uuid_1",
      "vendor_id": "V001",
      "vendor_name": "Acme Corp",
      "country": "US",
      "tax_id": "12-3456789"
    },
    {
      "id": "row_uuid_2",
      "vendor_id": "V002",
      "vendor_name": "Globex Inc",
      "country": "GB",
      "tax_id": "GB123456789"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 1250
  }
}

CSV Export

Download the entire reference data table as a CSV file. The response uses Content-Type: text/csv and includes a Content-Disposition header with the suggested filename. Column headers are derived from the table column schema.

GET/v1/reference-data/:id/csv

cURL — Download CSV

CSV output (example)

vendor_id,vendor_name,country,tax_id
V001,Acme Corp,US,12-3456789
V002,Globex Inc,GB,GB123456789
V003,Initech Ltd,DE,DE987654321

Errors

Error responses

400validation_errorInvalid page or limit parameter. limit must be between 1 and 500.
401unauthorizedMissing or invalid API key.
404not_foundNo reference data table with this ID exists for your workspace.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Get Reference Data
List & Create Reference Data
Run Matching