Activepieces Templates API

Flow templates

GitHub OpenAPI

Operations 6

GET /v1/templates/{id} Get templates by id #
POST /v1/templates/{id} Create templates by id #
DELETE /v1/templates/{id} Delete templates by id #
GET /v1/templates/categories Get templates categories #
GET /v1/templates Get templates #
POST /v1/templates Create templates #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/activepieces:activepieces-templates-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

activepieces-templates-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Activepieces Documentation Templates API
  version: 0.0.0
servers:
- url: https://cloud.activepieces.com/api
  description: Production Server
tags:
- name: Templates
paths:
  /v1/templates/{id}:
    get:
      tags:
      - Templates
      description: Get a template.
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Get templates by id
      x-summary-source: derived
      operationId: getV1TemplatesById
      x-operation-id-source: derived
    post:
      tags:
      - Templates
      description: Update a template.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                summary:
                  type: string
                description:
                  type: string
                tags:
                  type: array
                  items:
                    type: object
                    properties:
                      title:
                        type: string
                      color:
                        type: string
                        pattern: ^#[0-9A-Fa-f]{6}$
                      icon:
                        type: string
                    required:
                    - title
                    - color
                blogUrl:
                  type: string
                metadata:
                  anyOf:
                  - type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                  - type: 'null'
                status:
                  type: string
                  enum:
                  - PUBLISHED
                  - ARCHIVED
                categories:
                  type: array
                  items:
                    type: string
                flows:
                  type: array
                  items:
                    type: object
                    properties:
                      displayName:
                        type: string
                      trigger:
                        anyOf:
                        - type: object
                          properties:
                            name:
                              type: string
                              pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
                            valid:
                              type: boolean
                            displayName:
                              type: string
                            nextAction: {}
                            lastUpdatedDate:
                              type: string
                            type:
                              type: string
                              enum:
                              - PIECE_TRIGGER
                            settings:
                              type: object
                              properties:
                                sampleData:
                                  type: object
                                  properties:
                                    sampleDataFileId:
                                      type: string
                                    sampleDataInputFileId:
                                      type: string
                                    lastTestDate:
                                      type: string
                                propertySettings:
                                  type: object
                                  propertyNames:
                                    type: string
                                  additionalProperties:
                                    type: object
                                    properties:
                                      type:
                                        type: string
                                        enum:
                                        - MANUAL
                                        - DYNAMIC
                                      schema: {}
                                    required:
                                    - type
                                customLogoUrl:
                                  type: string
                                pieceName:
                                  type: string
                                pieceVersion:
                                  type: string
                                  pattern: ^([~^])?[0-9]+\.[0-9]+\.[0-9]+$
                                triggerName:
                                  type: string
                                input:
                                  type: object
                                  propertyNames:
                                    type: string
                                  additionalProperties: {}
                              required:
                              - propertySettings
                              - pieceName
                              - pieceVersion
                              - input
                          required:
                          - name
                          - valid
                          - displayName
                          - lastUpdatedDate
                          - type
                          - settings
                        - type: object
                          properties:
                            name:
                              type: string
                              pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
                            valid:
                              type: boolean
                            displayName:
                              type: string
                            nextAction: {}
                            lastUpdatedDate:
                              type: string
                            type:
                              type: string
                              enum:
                              - EMPTY
                            settings: {}
                          required:
                          - name
                          - valid
                          - displayName
                          - lastUpdatedDate
                          - type
                          - settings
                      valid:
                        type: boolean
                      schemaVersion:
                        anyOf:
                        - type: string
                        - type: 'null'
                      description:
                        type: string
                      notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            content:
                              type: string
                            ownerId:
                              anyOf:
                              - type: string
                              - type: 'null'
                            color:
                              type: string
                              enum:
                              - orange
                              - red
                              - green
                              - blue
                              - purple
                              - yellow
                            position:
                              type: object
                              properties:
                                x:
                                  type: number
                                y:
                                  type: number
                              required:
                              - x
                              - y
                            size:
                              type: object
                              properties:
                                width:
                                  type: number
                                height:
                                  type: number
                              required:
                              - width
                              - height
                            createdAt:
                              type: string
                            updatedAt:
                              type: string
                          required:
                          - id
                          - content
                          - color
                          - position
                          - size
                          - createdAt
                          - updatedAt
                    required:
                    - displayName
                    - trigger
                    - valid
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Create templates by id
      x-summary-source: derived
      operationId: postV1TemplatesById
      x-operation-id-source: derived
    delete:
      tags:
      - Templates
      description: Delete a template.
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Delete templates by id
      x-summary-source: derived
      operationId: deleteV1TemplatesById
      x-operation-id-source: derived
  /v1/templates/categories:
    get:
      tags:
      - Templates
      description: Get categories of templates.
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Get templates categories
      x-summary-source: derived
      operationId: getV1TemplatesCategories
      x-operation-id-source: derived
  /v1/templates:
    get:
      tags:
      - Templates
      description: List templates.
      parameters:
      - schema:
          type: string
          enum:
          - OFFICIAL
          - SHARED
          - CUSTOM
        in: query
        name: type
        required: false
      - schema:
          type: array
          items:
            type: string
        in: query
        name: pieces
        required: true
      - schema:
          type: array
          items:
            type: string
        in: query
        name: tags
        required: true
      - schema:
          type: string
        in: query
        name: search
        required: false
      - schema:
          type: string
        in: query
        name: category
        required: false
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Get templates
      x-summary-source: derived
      operationId: getV1Templates
      x-operation-id-source: derived
    post:
      tags:
      - Templates
      description: Create a template.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                summary:
                  type: string
                description:
                  type: string
                tags:
                  type: array
                  items:
                    type: object
                    properties:
                      title:
                        type: string
                      color:
                        type: string
                        pattern: ^#[0-9A-Fa-f]{6}$
                      icon:
                        type: string
                    required:
                    - title
                    - color
                blogUrl:
                  type: string
                metadata:
                  anyOf:
                  - type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                  - type: 'null'
                author:
                  type: string
                categories:
                  type: array
                  items:
                    type: string
                type:
                  type: string
                  enum:
                  - OFFICIAL
                  - SHARED
                  - CUSTOM
                flows:
                  type: array
                  items:
                    type: object
                    properties:
                      displayName:
                        type: string
                      trigger:
                        anyOf:
                        - type: object
                          properties:
                            name:
                              type: string
                              pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
                            valid:
                              type: boolean
                            displayName:
                              type: string
                            nextAction: {}
                            lastUpdatedDate:
                              type: string
                            type:
                              type: string
                              enum:
                              - PIECE_TRIGGER
                            settings:
                              type: object
                              properties:
                                sampleData:
                                  type: object
                                  properties:
                                    sampleDataFileId:
                                      type: string
                                    sampleDataInputFileId:
                                      type: string
                                    lastTestDate:
                                      type: string
                                propertySettings:
                                  type: object
                                  propertyNames:
                                    type: string
                                  additionalProperties:
                                    type: object
                                    properties:
                                      type:
                                        type: string
                                        enum:
                                        - MANUAL
                                        - DYNAMIC
                                      schema: {}
                                    required:
                                    - type
                                customLogoUrl:
                                  type: string
                                pieceName:
                                  type: string
                                pieceVersion:
                                  type: string
                                  pattern: ^([~^])?[0-9]+\.[0-9]+\.[0-9]+$
                                triggerName:
                                  type: string
                                input:
                                  type: object
                                  propertyNames:
                                    type: string
                                  additionalProperties: {}
                              required:
                              - propertySettings
                              - pieceName
                              - pieceVersion
                              - input
                          required:
                          - name
                          - valid
                          - displayName
                          - lastUpdatedDate
                          - type
                          - settings
                        - type: object
                          properties:
                            name:
                              type: string
                              pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
                            valid:
                              type: boolean
                            displayName:
                              type: string
                            nextAction: {}
                            lastUpdatedDate:
                              type: string
                            type:
                              type: string
                              enum:
                              - EMPTY
                            settings: {}
                          required:
                          - name
                          - valid
                          - displayName
                          - lastUpdatedDate
                          - type
                          - settings
                      valid:
                        type: boolean
                      schemaVersion:
                        anyOf:
                        - type: string
                        - type: 'null'
                      description:
                        type: string
                      notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            content:
                              type: string
                            ownerId:
                              anyOf:
                              - type: string
                              - type: 'null'
                            color:
                              type: string
                              enum:
                              - orange
                              - red
                              - green
                              - blue
                              - purple
                              - yellow
                            position:
                              type: object
                              properties:
                                x:
                                  type: number
                                y:
                                  type: number
                              required:
                              - x
                              - y
                            size:
                              type: object
                              properties:
                                width:
                                  type: number
                                height:
                                  type: number
                              required:
                              - width
                              - height
                            createdAt:
                              type: string
                            updatedAt:
                              type: string
                          required:
                          - id
                          - content
                          - color
                          - position
                          - size
                          - createdAt
                          - updatedAt
                    required:
                    - displayName
                    - trigger
                    - valid
              required:
              - name
              - summary
              - description
              - author
              - categories
              - type
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Create templates
      x-summary-source: derived
      operationId: postV1Templates
      x-operation-id-source: derived
components:
  securitySchemes:
    apiKey:
      type: http
      description: Use your api key generated from the admin console
      scheme: bearer
externalDocs:
  url: https://www.activepieces.com/docs
  description: Find more info here
x-provenance:
  method: harvested
  publisher: Activepieces
  source: https://www.activepieces.com/docs/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)