List Record Set Fields

List the field definitions of a record set including field keys, types, and display metadata. Fields define the columns available in the record set.

Retrieve the field definitions for a record set. Fields define the columns available in the set — each field has a key (column name), a type, and optional display metadata. The field list determines which cell values can appear in each record and how they should be interpreted by downstream consumers.

Field definitions are derived from the schema used during extraction or the policy used during resolution. They include the field key, value type, and optional attributes like display name and description. Use this endpoint to understand the shape of the data before fetching records, or to build dynamic table UIs that adapt to the field list.

Response

{
  "data": [
    { "field_key": "invoice_number", "type": "string", "display_name": "Invoice Number", "description": null, "ordinal": 0 },
    { "field_key": "vendor_name", "type": "string", "display_name": "Vendor Name", "description": null, "ordinal": 1 },
    { "field_key": "total_amount", "type": "number", "display_name": "Total Amount", "description": "Invoice total in local currency", "ordinal": 2 },
    { "field_key": "invoice_date", "type": "date", "display_name": "Invoice Date", "description": null, "ordinal": 3 }
  ]
}

Errors