Get Flow Run

curl --request GET \
  --url https://api.tableflow.com/v2/flows/runs/Wp7kRnT2mX4vQ9bL \
  --header 'Authorization: Bearer YOUR_API_KEY'

import requests

response = requests.get(
    "https://api.tableflow.com/v2/flows/runs/Wp7kRnT2mX4vQ9bL",
    headers={
        "Authorization": "Bearer YOUR_API_KEY"
    }
)

flow_run = response.json()

const response = await fetch("https://api.tableflow.com/v2/flows/runs/Wp7kRnT2mX4vQ9bL", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  }
});

const flowRun = await response.json();

{
  "id": "Wp7kRnT2mX4vQ9bL",
  "flow_id": "dk4g1tUg1uHLs8YU",
  "workspace_id": "uT2bJNWN75YPU95r",
  "status": "completed",
  "status_history": [
    {
      "status": "processing",
      "time": 1682366228,
      "message": "Flow started via api"
    },
    {
      "status": "completed",
      "time": 1682366258,
      "message": "Flow completed successfully"
    }
  ],
  "error": null,
  "metadata": {
    "customer_id": "12345",
    "order_number": "PO-2024-001"
  },
  "trigger_method": "api",
  "start_time": 1682366228,
  "end_time": 1682366258,
  "duration": 30000,
  "drive_files": {
    "reconciliation": {
      "file_id": "1ABC123DEF456",
      "mime_type": "application/vnd.google-apps.spreadsheet",
      "sheets": [
        {
          "sheet_id": 0,
          "title": "Reconciliation Results"
        }
      ]
    }
  },
  "flow": {
    "id": "dk4g1tUg1uHLs8YU",
    "workspace_id": "uT2bJNWN75YPU95r",
    "name": "PO to Invoice Reconciliation",
    "description": "Match purchase orders with invoices and verify totals",
    "steps": [
      {
        "id": "step_1",
        "title": "Extract Purchase Order",
        "type": "extraction"
      },
      {
        "id": "step_2",
        "title": "Extract Invoice",
        "type": "extraction"
      },
      {
        "id": "step_3",
        "title": "Reconcile Documents",
        "type": "reconciliation"
      }
    ],
    "active": true
  },
  "created_at": 1682366228,
  "updated_at": 1682366258
}

GET

flows

runs

{id}

curl --request GET \
  --url https://api.tableflow.com/v2/flows/runs/Wp7kRnT2mX4vQ9bL \
  --header 'Authorization: Bearer YOUR_API_KEY'

import requests

response = requests.get(
    "https://api.tableflow.com/v2/flows/runs/Wp7kRnT2mX4vQ9bL",
    headers={
        "Authorization": "Bearer YOUR_API_KEY"
    }
)

flow_run = response.json()

const response = await fetch("https://api.tableflow.com/v2/flows/runs/Wp7kRnT2mX4vQ9bL", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  }
});

const flowRun = await response.json();

{
  "id": "Wp7kRnT2mX4vQ9bL",
  "flow_id": "dk4g1tUg1uHLs8YU",
  "workspace_id": "uT2bJNWN75YPU95r",
  "status": "completed",
  "status_history": [
    {
      "status": "processing",
      "time": 1682366228,
      "message": "Flow started via api"
    },
    {
      "status": "completed",
      "time": 1682366258,
      "message": "Flow completed successfully"
    }
  ],
  "error": null,
  "metadata": {
    "customer_id": "12345",
    "order_number": "PO-2024-001"
  },
  "trigger_method": "api",
  "start_time": 1682366228,
  "end_time": 1682366258,
  "duration": 30000,
  "drive_files": {
    "reconciliation": {
      "file_id": "1ABC123DEF456",
      "mime_type": "application/vnd.google-apps.spreadsheet",
      "sheets": [
        {
          "sheet_id": 0,
          "title": "Reconciliation Results"
        }
      ]
    }
  },
  "flow": {
    "id": "dk4g1tUg1uHLs8YU",
    "workspace_id": "uT2bJNWN75YPU95r",
    "name": "PO to Invoice Reconciliation",
    "description": "Match purchase orders with invoices and verify totals",
    "steps": [
      {
        "id": "step_1",
        "title": "Extract Purchase Order",
        "type": "extraction"
      },
      {
        "id": "step_2",
        "title": "Extract Invoice",
        "type": "extraction"
      },
      {
        "id": "step_3",
        "title": "Reconcile Documents",
        "type": "reconciliation"
      }
    ],
    "active": true
  },
  "created_at": 1682366228,
  "updated_at": 1682366258
}

Retrieves detailed information about a specific flow run, including its current status and execution history.

Usage Notes

The response includes the flow definition for context
Use this endpoint to monitor flow execution progress
Poll this endpoint to check when a flow completes
The drive_files object contains links to Google Drive exports (if enabled)

Request

string

required

The ID of the flow run

Response

{
  "id": "Wp7kRnT2mX4vQ9bL",
  "flow_id": "dk4g1tUg1uHLs8YU",
  "workspace_id": "uT2bJNWN75YPU95r",
  "status": "completed",
  "status_history": [
    {
      "status": "processing",
      "time": 1682366228,
      "message": "Flow started via api"
    },
    {
      "status": "completed",
      "time": 1682366258,
      "message": "Flow completed successfully"
    }
  ],
  "error": null,
  "metadata": {
    "customer_id": "12345",
    "order_number": "PO-2024-001"
  },
  "trigger_method": "api",
  "start_time": 1682366228,
  "end_time": 1682366258,
  "duration": 30000,
  "drive_files": {
    "reconciliation": {
      "file_id": "1ABC123DEF456",
      "mime_type": "application/vnd.google-apps.spreadsheet",
      "sheets": [
        {
          "sheet_id": 0,
          "title": "Reconciliation Results"
        }
      ]
    }
  },
  "flow": {
    "id": "dk4g1tUg1uHLs8YU",
    "workspace_id": "uT2bJNWN75YPU95r",
    "name": "PO to Invoice Reconciliation",
    "description": "Match purchase orders with invoices and verify totals",
    "steps": [
      {
        "id": "step_1",
        "title": "Extract Purchase Order",
        "type": "extraction"
      },
      {
        "id": "step_2",
        "title": "Extract Invoice",
        "type": "extraction"
      },
      {
        "id": "step_3",
        "title": "Reconcile Documents",
        "type": "reconciliation"
      }
    ],
    "active": true
  },
  "created_at": 1682366228,
  "updated_at": 1682366258
}

curl --request GET \
  --url https://api.tableflow.com/v2/flows/runs/Wp7kRnT2mX4vQ9bL \
  --header 'Authorization: Bearer YOUR_API_KEY'

import requests

response = requests.get(
    "https://api.tableflow.com/v2/flows/runs/Wp7kRnT2mX4vQ9bL",
    headers={
        "Authorization": "Bearer YOUR_API_KEY"
    }
)

flow_run = response.json()

const response = await fetch("https://api.tableflow.com/v2/flows/runs/Wp7kRnT2mX4vQ9bL", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  }
});

const flowRun = await response.json();

string

required

The unique identifier for the flow run

string

required

The ID of the flow being executed

string

required

The workspace ID

string

required

Current status of the flow run

processing - Flow is currently executing
review - Flow is paused for human review
completed - Flow completed successfully
failed - Flow failed (check error field)

array

required

History of status changes

Show Status History Entry

string

required

The status value

number

required

Unix timestamp of the status change

string

required

Description of the status change

string

Error message if the flow run failed

object

Custom metadata provided when running the flow

string

required

How the flow was triggered: api or manual

number

required

Unix timestamp when the flow run started

number

Unix timestamp when the flow run completed

number

required

Duration of the flow run in milliseconds

object

Google Drive files created during the flow (if Google Drive integration is enabled).

array

History of flow execution attempts, including retries. Each attempt contains details about step executions for that attempt.

integer

The current attempt number (1-based). Increments when a flow is rerun.

object

Map of file field keys to the files that were uploaded for this flow run, including file names, types, and sizes.

array

Step execution details for all attempts. Each step execution includes the step ID, status, timing, and any outputs or errors.

object

The flow definition at the time of execution (included for context).

number

required

Unix timestamp when the flow run was created

number

required

Unix timestamp when the flow run was last updated

Run Flow

Extractions

Flows

Usage Notes

Request

Response

​Usage Notes

​Request

​Response

Usage Notes

Request

Response