Skip to main content

List Record Set Records

List records in a record set with offset-based pagination. Each record contains typed cells with values, confidence scores, and provenance metadata.

Retrieve the records (rows) in a record set with offset-based pagination. Each record contains a set of typed cells keyed by field name. Every cell carries a value, a confidence score (0-1), a status indicator, and provenance metadata tracing the value back to its source. This endpoint is the primary way to read structured data from the value plane.

Unlike the cursor-based pagination used by most list endpoints, record set records use offset-based pagination with page and limit parameters. This is intentional: record sets are table-like structures where random access by page number is a common use case for building paginated table UIs. The total record count is available on the parent record set object.

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

Response

Response fields

dataarrayArray of record objects.
data[].idstringRecord UUID.
data[].document_idstring | nullAssociated document UUID, if applicable.
data[].cellsobjectMap of field_key to cell objects.
data[].cells[key].valuestring | nullThe cell value.
data[].cells[key].confidencenumberConfidence score (0-1).
data[].cells[key].statusstringCell status (e.g. extracted, resolved, manual).
data[].cells[key].sourcestring | nullProvenance trace indicating how the value was produced.
pageintegerCurrent page number.
totalintegerTotal number of records.

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,
          "status": "extracted",
          "source": "chunk:3/line:12"
        },
        "country_code": {
          "value": "DE",
          "confidence": 0.95,
          "status": "resolved",
          "source": "lookup:country_codes"
        }
      }
    }
  ],
  "page": 1,
  "total": 142
}

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.