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

Manage third-party app connections

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

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

3 operations 2 paths 3 schemas 1 DELETE1 GET1 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 Connections 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 3

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

Connections 3

Manage third-party app connections

GET
/connections
Activepieces List Connections
listConnections 4 params → 200
POST
/connections
Activepieces Upsert Connection
upsertConnection body → 201
DELETE
/connections/{id}
Activepieces Delete Connection
deleteConnection 1 param → 204

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Connection (8 properties), UpsertConnectionRequest (5 properties), ConnectionList (3 properties). Each schema is shown below with its type and property counts.

Connection
object
An app connection (credentials for a third-party service)
8 properties
UpsertConnectionRequest
object
Request body for creating or updating a connection
5 properties 5 required
ConnectionList
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activepieces-connections-api-openapi.yml Raw ↑

Other APIs Activepieces publishes across the network.

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