Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Activepieces Flow Runs API

Access execution history and run details

Activepieces Flow Runs API is one of 9 APIs that Activepieces publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Flow Runs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 6 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://cloud.activepieces.com/api/v1, https://{yourDomain}/api/v1.

2 operations 2 paths 2 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://cloud.activepieces.com/api/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Activepieces Flow Runs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — API key from the Activepieces admin console, passed as a Bearer token

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Flow Runs 2

Access execution history and run details

GET
/flow-runs
Activepieces List Flow Runs
listFlowRuns 5 params → 200
GET
/flow-runs/{id}
Activepieces Get Flow Run
getFlowRun 1 param → 200404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are FlowRun (9 properties), FlowRunList (3 properties). Each schema is shown below with its type and property counts.

FlowRunList
object
Paginated list of flow runs
3 properties
FlowRun
object
A flow execution run
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activepieces-flow-runs-api-openapi.yml Raw ↑

Other APIs Activepieces publishes across the network.

Activepieces Connections API
Activepieces Flows API
Activepieces Folders API
Activepieces Pieces API
Activepieces Projects API
Activepieces Templates API
Activepieces Users API
Activepieces Worker Machines API