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 Flows API

Manage automation workflows

Activepieces Flows 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 Flows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 6 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 4 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.

5 operations 2 paths 4 schemas 1 DELETE2 GET2 POST

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 Flows 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 5

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

Flows 5

Manage automation workflows

GET
/flows
Activepieces List Flows
listFlows 6 params → 200401
POST
/flows
Activepieces Create Flow
createFlow body → 201400401
GET
/flows/{id}
Activepieces Get Flow
getFlow 1 param → 200404
POST
/flows/{id}
Activepieces Update Flow
updateFlow 1 param body → 200
DELETE
/flows/{id}
Activepieces Delete Flow
deleteFlow 1 param → 204404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Flow (9 properties), CreateFlowRequest (5 properties), FlowList (3 properties), UpdateFlowRequest (3 properties). Each schema is shown below with its type and property counts.

UpdateFlowRequest
object
Request body for updating a flow
3 properties
FlowList
object
Paginated list of flows
3 properties
CreateFlowRequest
object
Request body for creating a flow
5 properties 2 required
Flow
object
An Activepieces automation flow
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activepieces-flows-api-openapi.yml Raw ↑

Other APIs Activepieces publishes across the network.

Activepieces Connections API
Activepieces Flow Runs API
Activepieces Folders API
Activepieces Pieces API
Activepieces Projects API
Activepieces Templates API
Activepieces Users API
Activepieces Worker Machines API