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

Manage integration pieces

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

This API exposes 1 operation across 1 path, and defines 1 schema. 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.

1 operations 1 paths 1 schemas 1 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 Pieces 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 1

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

Pieces 1

Manage integration pieces

GET
/pieces
Activepieces List Pieces
listPieces 2 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Piece (6 properties). Each schema is shown below with its type and property counts.

Piece
object
An Activepieces integration piece
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activepieces-pieces-api-openapi.yml Raw ↑

Other APIs Activepieces publishes across the network.

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