Flow Run Logs | Core API Reference | Product documentation

List Flow Runs

get

Retrieves a paginated list of flow runs. Can be filtered by user_id, flow_id, flow_version_id, virtual_environment_id, trigger, status, date range, and other criteria.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Query parameters

filter[user_id]stringOptional

Filter results by user_id.

filter[flow_id]stringOptional

Filter results by flow_id.

filter[flow_version_id]stringOptional

Filter results by flow_version_id.

filter[virtual_environment_id]stringOptional

Filter results by virtual_environment_id.

filter[trigger]stringOptional

Filter results by trigger.

filter[status]stringOptional

Filter results by status.

filter[search]stringOptional

Filter results by search.

filter[started_before]stringOptional

Filter results to flow runs that started before the specified time. Accepts a Unix timestamp in milliseconds, e.g. 2026-03-01 19:00 converts to 1772391627000 so 1772391627000 is the parameter value.

filter[started_after]stringOptional

Filter results to flow runs that started after the specified time. Accepts a Unix timestamp in milliseconds.

filter[started_on]stringOptional

Filter results to flow runs that started on the specified date. Accepts a Unix timestamp in milliseconds.

filter[retried]stringOptional

Filter results by retried.

filter[has_warnings]stringOptional

Filter results by has_warnings.

includestringOptional

Comma-separated list of relationships to include. Available: flowVersion, flowVersion.steps, flow, flowRunLogs, errorWarningLogs, flowRunLogs.flowStep, trackedData, metrics, cpuTime, payloadSize, operationsSent, operationsReceived, retriedFlowRun, virtualEnvironmentVersion, virtualEnvironmentVersion.virtualEnvironment

sortstringOptional

Sort field. Prefix with - for descending. Available: started_at

fields[trackedData]stringOptional

Comma-separated list of trackedData fields to return. Available: id

fields[flow]stringOptional

Comma-separated list of flow fields to return. Available: id, name

fields[flowVersion]stringOptional

Comma-separated list of flowVersion fields to return. Available: steps.name

fields[retriedFlowRun]stringOptional

Comma-separated list of retriedFlowRun fields to return. Available: id, status

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-runs

GET /api/v1/flow-runs HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "string",
      "flow_id": 0,
      "flow_version_id": 0,
      "virtual_environment_version": null,
      "trigger": "string",
      "status": 0,
      "has_warnings": false,
      "started_at": "2025-01-15T10:30:00.000000Z",
      "duration": 0,
      "retry_flow_run_id": null,
      "summary": null,
      "flow": {
        "id": 0,
        "name": "string",
        "deleted_at": null
      },
      "flow_version": {
        "id": 0,
        "iteration": 0,
        "deleted_at": null
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/flow-runs",
    "per_page": 15,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/flow-runs?page=1",
    "last": "https://api.example.com/api/v1/flow-runs?page=1",
    "prev": null,
    "next": null
  }
}

Get Flow Run

get

Retrieves the details of a specific flow run.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_runstringRequired

The flow run identifier.

Query parameters

filter[user_id]stringOptional

Filter results by user_id.

filter[flow_id]stringOptional

Filter results by flow_id.

filter[flow_version_id]stringOptional

Filter results by flow_version_id.

filter[virtual_environment_id]stringOptional

Filter results by virtual_environment_id.

filter[trigger]stringOptional

Filter results by trigger.

filter[status]stringOptional

Filter results by status.

filter[search]stringOptional

Filter results by search.

filter[started_before]stringOptional

Filter results to flow runs that started before the specified time. Accepts a Unix timestamp in milliseconds, e.g. 2026-03-01 19:00 converts to 1772391627000 so 1772391627000 is the parameter value.

filter[started_after]stringOptional

Filter results to flow runs that started after the specified time. Accepts a Unix timestamp in milliseconds.

filter[started_on]stringOptional

Filter results to flow runs that started on the specified date. Accepts a Unix timestamp in milliseconds.

filter[retried]stringOptional

Filter results by retried.

filter[has_warnings]stringOptional

Filter results by has_warnings.

includestringOptional

Comma-separated list of relationships to include. Available: flowVersion, flowVersion.steps, flow, flowRunLogs, errorWarningLogs, flowRunLogs.flowStep, trackedData, metrics, cpuTime, payloadSize, operationsSent, operationsReceived, retriedFlowRun, virtualEnvironmentVersion, virtualEnvironmentVersion.virtualEnvironment

sortstringOptional

Sort field. Prefix with - for descending. Available: started_at

fields[trackedData]stringOptional

Comma-separated list of trackedData fields to return. Available: id

fields[flow]stringOptional

Comma-separated list of flow fields to return. Available: id, name

fields[flowVersion]stringOptional

Comma-separated list of flowVersion fields to return. Available: steps.name

fields[retriedFlowRun]stringOptional

Comma-separated list of retriedFlowRun fields to return. Available: id, status

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-runs/{flow_run}

GET /api/v1/flow-runs/{flow_run} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": "string",
    "flow_id": 0,
    "flow_version_id": 0,
    "user_id": null,
    "trigger": "string",
    "status": 0,
    "summary": null,
    "started_at": "2025-01-15T10:30:00.000000Z",
    "finished_at": "2025-01-15T10:30:00.000000Z",
    "duration": 0,
    "retry_flow_run_id": null,
    "has_warnings": false,
    "starting_payload_count": 0,
    "starting_payload_size": 0,
    "flow": {
      "id": 0,
      "name": "string"
    },
    "flow_version": {
      "id": 0,
      "flow_id": 0,
      "iteration": 0,
      "status": "string",
      "is_deployed": false
    }
  }
}

Download Run Logs

get

Queues a download of the detailed logs for a specific flow run. The downloaded file is added to the File Downloads section in General Settings.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_runstringRequired

The flow run identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-runs/{flow_run}/download

GET /api/v1/flow-runs/{flow_run}/download HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "string"
}

List Run Logs

get

Retrieves a paginated list of logs for a specific flow run. Can be filtered by flow_step_id.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_runstringRequired

The flow run identifier.

Query parameters

filter[flow_step_id]stringOptional

Filter results by flow_step_id.

includestringOptional

Comma-separated list of relationships to include. Available: flowRun, flowStep, flowRunLogMetadata, flowRunLogPayloads, flowStep.payloads

fields[flowStep]stringOptional

Comma-separated list of flowStep fields to return. Available: id, name, payload.id

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-runs/{flow_run}/flow-run-logs

GET /api/v1/flow-runs/{flow_run}/flow-run-logs HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "My Example",
      "payload.id": "example_payload.id",
      "steps.name": "example_steps.name",
      "status": "Draft",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "flow_id": 1,
      "flow_version_id": 1,
      "virtual_environment_version": {},
      "user_id": 1,
      "trigger": "API",
      "summary": "example_summary",
      "started_at": "2025-01-15T10:30:00.000000Z",
      "finished_at": "2025-01-15T10:30:00.000000Z",
      "duration": {},
      "retry_flow_run_id": 1,
      "retried_flow_run": [],
      "has_warnings": [],
      "flow_run_logs": [],
      "flow": [],
      "flow_version": [],
      "metrics": [],
      "cpu_time": "example_cpu_time",
      "payload_size": "example_payload_size",
      "operations_sent": "example_operations_sent",
      "operations_received": "example_operations_received",
      "score": "example_score",
      "starting_payload_count": 5,
      "starting_payload_size": "example_starting_payload_size",
      "flow_steps_with_errors": "example_flow_steps_with_errors"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/flow-runs/{flow_run}/flow-run-logs",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/flow-runs/{flow_run}/flow-run-logs?page=1",
    "last": "https://api.example.com/api/v1/flow-runs/{flow_run}/flow-run-logs?page=1",
    "prev": null,
    "next": null
  }
}

Get Run Log

get

Retrieves the details of a specific flow run log.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_runstringRequired

The flow run identifier.

flow_run_logstringRequired

The flow run log identifier.

Query parameters

filter[flow_step_id]stringOptional

Filter results by flow_step_id.

includestringOptional

Comma-separated list of relationships to include. Available: flowRun, flowStep, flowRunLogMetadata, flowRunLogPayloads, flowStep.payloads

fields[flowStep]stringOptional

Comma-separated list of flowStep fields to return. Available: id, name, payload.id

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-runs/{flow_run}/flow-run-logs/{flow_run_log}

GET /api/v1/flow-runs/{flow_run}/flow-run-logs/{flow_run_log} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "name": "My Example",
    "payload.id": "example_payload.id",
    "steps.name": "example_steps.name",
    "status": "Draft",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_id": 1,
    "flow_version_id": 1,
    "virtual_environment_version": {},
    "user_id": 1,
    "trigger": "API",
    "summary": "example_summary",
    "started_at": "2025-01-15T10:30:00.000000Z",
    "finished_at": "2025-01-15T10:30:00.000000Z",
    "duration": {},
    "retry_flow_run_id": 1,
    "retried_flow_run": [],
    "has_warnings": [],
    "flow_run_logs": [],
    "flow": [],
    "flow_version": [],
    "metrics": [],
    "cpu_time": "example_cpu_time",
    "payload_size": "example_payload_size",
    "operations_sent": "example_operations_sent",
    "operations_received": "example_operations_received",
    "score": "example_score",
    "starting_payload_count": 5,
    "starting_payload_size": "example_starting_payload_size",
    "flow_steps_with_errors": "example_flow_steps_with_errors"
  }
}

Retry Flow Run

post

Retries a specific flow run.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_runstringRequired

The flow run identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-runs/{flow_run}/retry

POST /api/v1/flow-runs/{flow_run}/retry HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}

Stop Flow Run

post

Stops a specific flow run that is currently in progress.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_runstringRequired

The flow run identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-runs/{flow_run}/stop

POST /api/v1/flow-runs/{flow_run}/stop HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}

hashtagList Flow Runs

hashtagGet Flow Run

hashtagDownload Run Logs

hashtagList Run Logs

hashtagGet Run Log

hashtagRetry Flow Run

hashtagStop Flow Run

List Flow Runs

Get Flow Run

Download Run Logs

List Run Logs

Get Run Log

Retry Flow Run

Stop Flow Run