Pieces API

List available pieces (integrations) and their triggers and actions.

List Pieces

Retrieve all available pieces.

GET /api/v1/pieces

Query Parameters:

Parameter	Type	Description
limit	integer	Max results per page (default: 50, max: 200)
cursor	string	Pagination cursor
search	string	Search by piece name
category	string	Filter by category (e.g., crm, email, messaging)

Example:

curl -X GET "https://app.onflowstack.com/api/v1/pieces?search=gmail&limit=5" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "data": [
    {
      "name": "@activepieces/piece-gmail",
      "displayName": "Gmail",
      "description": "Send and receive emails via Gmail",
      "logoUrl": "https://cdn.activepieces.com/pieces/gmail.png",
      "version": "0.12.3",
      "categories": ["email", "communication"],
      "auth": {
        "type": "OAUTH2",
        "provider": "google"
      },
      "triggers": [
        {
          "name": "new_email",
          "displayName": "New Email",
          "description": "Triggers when a new email is received"
        },
        {
          "name": "new_labeled_email",
          "displayName": "New Labeled Email",
          "description": "Triggers when an email receives a specific label"
        }
      ],
      "actions": [
        {
          "name": "send_email",
          "displayName": "Send Email",
          "description": "Send an email from your Gmail account"
        },
        {
          "name": "create_draft",
          "displayName": "Create Draft",
          "description": "Create a draft email"
        },
        {
          "name": "get_email",
          "displayName": "Get Email",
          "description": "Retrieve a specific email by ID"
        }
      ]
    }
  ],
  "cursor": null,
  "hasMore": false
}

Get Piece Details

Retrieve detailed information about a specific piece, including all triggers, actions, and their input schemas.

GET /api/v1/pieces/{pieceName}

Example:

curl -X GET "https://app.onflowstack.com/api/v1/pieces/@activepieces/piece-gmail" \
  -H "Authorization: Bearer YOUR_API_KEY"

Piece Categories

Category	Description	Count
crm	Customer Relationship Management	25+
email	Email services	15+
messaging	Chat and messaging	20+
spreadsheets	Spreadsheets and databases	15+
project-management	Task and project tracking	30+
dev-tools	Developer tools and CI/CD	25+
payments	Payment processing	10+
storage	File storage and management	15+
marketing	Marketing automation	20+
ai	AI and machine learning	15+
communication	Voice, SMS, video	10+
other	Miscellaneous	100+