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

Organize flows with folders

Activepieces Folders 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 Folders. 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 Folders 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.

Folders 5

Organize flows with folders

GET
/folders
Activepieces List Folders
listFolders 3 params → 200
POST
/folders
Activepieces Create Folder
createFolder body → 201
GET
/folders/{id}
Activepieces Get Folder
getFolder 1 param → 200
POST
/folders/{id}
Activepieces Update Folder
updateFolder 1 param body → 200
DELETE
/folders/{id}
Activepieces Delete Folder
deleteFolder 1 param → 204

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Folder (5 properties), FolderList (3 properties), CreateFolderRequest (2 properties), UpdateFolderRequest (1 property). Each schema is shown below with its type and property counts.

CreateFolderRequest
object
2 properties 2 required
Folder
object
A folder for organizing flows
5 properties
UpdateFolderRequest
object
1 property
FolderList
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activepieces-folders-api-openapi.yml Raw ↑

Other APIs Activepieces publishes across the network.

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