Get Extraction Table Rows

Get paginated rows from an extraction table

GET /v2/extractions/{id}/tables/{tableKey}/rows

cURL

curl -X GET https://api.tableflow.com/v2/extractions/uT2bJNWN75YPU95r/tables/line_items/rows?offset=0&limit=100 \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "pagination": {
    "offset": 0,
    "limit": 100,
    "total": 3,
    "next_offset": null,
    "filter": "all"
  },
  "rows": [
    {
      "index": 0,
      "values": {
        "description": "Ergonomic Office Chair",
        "quantity": "1",
        "unit_price": "249.99",
        "amount": "249.99"
      },
      "validations": {}
    },
    {
      "index": 1,
      "values": {
        "description": "Wireless Keyboard",
        "quantity": "2",
        "unit_price": "59.95",
        "amount": "119.90"
      },
      "validations": {}
    },
    {
      "index": 2,
      "values": {
        "description": "27-inch Monitor",
        "quantity": "2",
        "unit_price": "329.99",
        "amount": "659.98"
      },
      "validations": {}
    }
  ]
}

Retrieves paginated rows from a specific table in an extraction. This endpoint is useful for accessing large tables efficiently.

Usage Notes

• Use pagination to retrieve rows from large tables
• Row indexes are 0-based, meaning the first row has an index of 0
• When no offset or limit is provided, defaults to offset 0 and limit 100
• Multiple filters can be combined using comma-separated values (e.g., filter=error,warn)

Request

id · string · required

The ID of the extraction.

tableKey · string · required

The key of the table to retrieve rows from.

offset · integer · default: "0"

The number of rows to skip. Minimum value is 0.

limit · integer · default: "100"

The maximum number of rows to return. Minimum value is 1, maximum value is 1000.

filter · string · default: "all"

Filter rows by status or validation state. Supports comma-separated values for multiple filters.

• all - Return all rows (default)
• valid - Rows that pass all validations
• invalid - Rows that fail at least one validation
• error - Rows with error-severity validations
• warn - Rows with warning-severity validations
• info - Rows with info-severity validations

column_validations · string

Filter to only return rows that have validations in specific columns. Provide column keys as comma-separated values (e.g., column_validations=unit_price,quantity). Only rows with validation issues in any of the specified columns will be returned.

cURL

curl -X GET https://api.tableflow.com/v2/extractions/uT2bJNWN75YPU95r/tables/line_items/rows?offset=0&limit=100 \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

pagination · object

Pagination information.

Show pagination

offset · integer

Current offset.

limit · integer

Current limit.

total · integer

Total number of rows in the table.

next_offset · integer

Offset for the next page of results. Will be null on the last page.

filter · string

The applied filter (e.g., “all”, “valid”, “invalid”, “error”).

rows · array

Array of table rows.

Show rows

index · integer

The row index (0-based).

values · object

Map of column keys to their cell values.

Show values

{column_key} · string

The value of this cell.

validations · object

Map of column keys to arrays of validation issues.

Show validations

{column_key} · array

Array of validation issues for the cell.

Show validation

validate · string

The validation that failed.

severity · string

Severity of the validation issue (“error”, “warn”, “info”).

message · string

Error message describing the validation issue.

{
  "pagination": {
    "offset": 0,
    "limit": 100,
    "total": 3,
    "next_offset": null,
    "filter": "all"
  },
  "rows": [
    {
      "index": 0,
      "values": {
        "description": "Ergonomic Office Chair",
        "quantity": "1",
        "unit_price": "249.99",
        "amount": "249.99"
      },
      "validations": {}
    },
    {
      "index": 1,
      "values": {
        "description": "Wireless Keyboard",
        "quantity": "2",
        "unit_price": "59.95",
        "amount": "119.90"
      },
      "validations": {}
    },
    {
      "index": 2,
      "values": {
        "description": "27-inch Monitor",
        "quantity": "2",
        "unit_price": "329.99",
        "amount": "659.98"
      },
      "validations": {}
    }
  ]
}

Error Responses

error · string

Error message describing what went wrong.

400 Bad Request

{
  "error": "The parameter 'filter' contains invalid value: unknown"
}