GET
/
v2
/
flows
/
runs
curl --request GET \
  --url 'https://api.tableflow.com/v2/flows/runs?status=completed&limit=50' \
  --header 'Authorization: Bearer YOUR_API_KEY'
{
  "flow_runs": [
    {
      "id": "fr_abc123def456",
      "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": {},
      "created_at": 1682366228,
      "updated_at": 1682366258
    },
    {
      "id": "fr_def456ghi789",
      "flow_id": "dk4g1tUg1uHLs8YU",
      "workspace_id": "uT2bJNWN75YPU95r",
      "status": "processing",
      "status_history": [
        {
          "status": "processing",
          "time": 1682366328,
          "message": "Flow started via api"
        }
      ],
      "error": null,
      "metadata": {
        "customer_id": "67890"
      },
      "trigger_method": "api",
      "start_time": 1682366328,
      "end_time": null,
      "duration": 0,
      "drive_files": {},
      "created_at": 1682366328,
      "updated_at": 1682366328
    }
  ],
  "pagination": {
    "total": 250,
    "limit": 100,
    "offset": 0,
    "next_offset": 100,
    "filter": "all"
  }
}

Retrieves a paginated list of flow runs with optional filtering by flow ID or status.

Usage Notes

  • Results are paginated with a default limit of 100
  • Results are ordered by creation date (newest first)
  • Use filters to narrow down results by flow or status
  • The response includes complete flow run details

Request

flow_id
string

Filter by flow ID

status
string

Filter by status: processing, review, completed, or failed

limit
number

Maximum number of results to return (default: 100, max: 1000)

offset
number

Number of results to skip (default: 0)

Response

{
  "flow_runs": [
    {
      "id": "fr_abc123def456",
      "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": {},
      "created_at": 1682366228,
      "updated_at": 1682366258
    },
    {
      "id": "fr_def456ghi789",
      "flow_id": "dk4g1tUg1uHLs8YU",
      "workspace_id": "uT2bJNWN75YPU95r",
      "status": "processing",
      "status_history": [
        {
          "status": "processing",
          "time": 1682366328,
          "message": "Flow started via api"
        }
      ],
      "error": null,
      "metadata": {
        "customer_id": "67890"
      },
      "trigger_method": "api",
      "start_time": 1682366328,
      "end_time": null,
      "duration": 0,
      "drive_files": {},
      "created_at": 1682366328,
      "updated_at": 1682366328
    }
  ],
  "pagination": {
    "total": 250,
    "limit": 100,
    "offset": 0,
    "next_offset": 100,
    "filter": "all"
  }
}
curl --request GET \
  --url 'https://api.tableflow.com/v2/flows/runs?status=completed&limit=50' \
  --header 'Authorization: Bearer YOUR_API_KEY'
flow_runs
array
required

Array of flow run objects

pagination
object
required

Pagination information