List Extractions

Get a paginated list of extractions in your workspace

GET /v2/extractions

cURL

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

{
  "extractions": [
    {
      "id": "uT2bJNWN75YPU95r",
      "status": "completed",
      "template_id": "JlLZVabDjYWzu7C9",
      "metadata": {
        "user_id": "123",
        "reference": "INV-2023-04-15"
      },
      "created_at": 1682366228,
      "updated_at": 1682366240,
      "file_info": {
        "file_name": "acme-invoice-apr2023.pdf",
        "file_type": "pdf"
      }
    },
    {
      "id": "xK9mPqR3vW7nB2cD",
      "status": "processing",
      "template_id": "JlLZVabDjYWzu7C9",
      "metadata": null,
      "created_at": 1682366300,
      "updated_at": 1682366300,
      "file_info": {
        "file_name": "quarterly-report.xlsx",
        "file_type": "xlsx"
      }
    }
  ],
  "total": 47,
  "limit": 100,
  "offset": 0
}

Retrieves a paginated list of extractions in your workspace. Returns a summary of each extraction including status, template, and file information.

Usage Notes

• Results are ordered by creation date (newest first)
• Use template_id to filter extractions by a specific template
• For full extraction data including fields and tables, use the Get Extraction endpoint

Request

template_id · string

Filter extractions by a specific template ID.

limit · integer · default: "100"

Maximum number of extractions to return. Maximum value is 1000.

offset · integer · default: "0"

Number of extractions to skip for pagination.

cURL

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

Response

extractions · array

Array of extraction summary objects.

Show extraction

id · string

The unique identifier for the extraction.

status · string

The current status of the extraction (processing, completed, or failed).

template_id · string

The ID of the template used for the extraction.

metadata · object

Custom metadata associated with the extraction.

created_at · integer

Unix timestamp when the extraction was created.

updated_at · integer

Unix timestamp when the extraction was last updated.

file_info · object

Basic information about the uploaded file.

Show file_info

file_name · string

The name of the uploaded file.

file_type · string

The file type key (e.g., pdf, csv, xlsx).

total · integer

Total number of extractions matching the query.

limit · integer

The limit applied to this request.

offset · integer

The offset applied to this request.

{
  "extractions": [
    {
      "id": "uT2bJNWN75YPU95r",
      "status": "completed",
      "template_id": "JlLZVabDjYWzu7C9",
      "metadata": {
        "user_id": "123",
        "reference": "INV-2023-04-15"
      },
      "created_at": 1682366228,
      "updated_at": 1682366240,
      "file_info": {
        "file_name": "acme-invoice-apr2023.pdf",
        "file_type": "pdf"
      }
    },
    {
      "id": "xK9mPqR3vW7nB2cD",
      "status": "processing",
      "template_id": "JlLZVabDjYWzu7C9",
      "metadata": null,
      "created_at": 1682366300,
      "updated_at": 1682366300,
      "file_info": {
        "file_name": "quarterly-report.xlsx",
        "file_type": "xlsx"
      }
    }
  ],
  "total": 47,
  "limit": 100,
  "offset": 0
}