Activepieces Projects API

Project management

GitHub OpenAPI

Operations 4

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

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-projects-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-projects-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Activepieces Documentation Projects API
  version: 0.0.0
servers:
- url: https://cloud.activepieces.com/api
  description: Production Server
tags:
- name: Projects
paths:
  /v1/projects:
    post:
      tags:
      - Projects
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                displayName:
                  type: string
                  pattern: ^[^./]+$
                externalId:
                  anyOf:
                  - type: string
                  - type: 'null'
                metadata:
                  anyOf:
                  - type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                  - type: 'null'
                maxConcurrentJobs:
                  anyOf:
                  - type: number
                  - type: 'null'
                globalConnectionExternalIds:
                  type: array
                  items:
                    type: string
                alertReceiverEmail:
                  anyOf:
                  - type: string
                    format: email
                    pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
                  - type: 'null'
              required:
              - displayName
        required: true
      security:
      - apiKey: []
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/project'
      summary: Create projects
      x-summary-source: derived
      operationId: postV1Projects
      x-operation-id-source: derived
    get:
      tags:
      - Projects
      parameters:
      - schema:
          type: string
        in: query
        name: externalId
        required: false
      - schema:
          type: string
        in: query
        name: externalUserId
        required: false
      - schema:
          type: number
        in: query
        name: limit
        required: false
      - schema:
          type: string
        in: query
        name: cursor
        required: false
      - schema:
          type: string
        in: query
        name: displayName
        required: false
      - schema:
          type: array
          items:
            type: string
            enum:
            - TEAM
            - PERSONAL
        in: query
        name: types
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/project'
                  next:
                    anyOf:
                    - type: string
                    - type: 'null'
                  previous:
                    anyOf:
                    - type: string
                    - type: 'null'
                required:
                - data
                additionalProperties: false
      summary: Get projects
      x-summary-source: derived
      operationId: getV1Projects
      x-operation-id-source: derived
  /v1/projects/{id}:
    post:
      tags:
      - Projects
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                releasesEnabled:
                  type: boolean
                displayName:
                  type: string
                  pattern: ^[^./]+$
                externalId:
                  type: string
                metadata:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties: {}
                icon:
                  type: object
                  properties:
                    color:
                      type: string
                      enum:
                      - RED
                      - BLUE
                      - YELLOW
                      - PURPLE
                      - GREEN
                      - PINK
                      - VIOLET
                      - ORANGE
                      - DARK_GREEN
                      - CYAN
                      - LAVENDER
                      - DEEP_ORANGE
                  required:
                  - color
                plan:
                  type: object
                  properties:
                    pieces:
                      type: array
                      items:
                        type: string
                    piecesFilterType:
                      type: string
                      enum:
                      - NONE
                      - ALLOWED
                globalConnectionExternalIds:
                  type: array
                  items:
                    type: string
                maxConcurrentJobs:
                  anyOf:
                  - type: integer
                    exclusiveMinimum: 0
                    maximum: 9007199254740991
                  - type: 'null'
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/project'
      summary: Create projects by id
      x-summary-source: derived
      operationId: postV1ProjectsById
      x-operation-id-source: derived
    delete:
      tags:
      - Projects
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Delete projects by id
      x-summary-source: derived
      operationId: deleteV1ProjectsById
      x-operation-id-source: derived
components:
  schemas:
    project:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/project'
      type: object
      properties:
        id:
          type: string
        created:
          type: string
        updated:
          type: string
        ownerId:
          type: string
        displayName:
          type: string
        platformId:
          type: string
          pattern: ^[0-9a-zA-Z]{21}$
        maxConcurrentJobs:
          anyOf:
          - type: number
          - type: 'null'
        type:
          type: string
          enum:
          - TEAM
          - PERSONAL
        icon:
          type: object
          properties:
            color:
              type: string
              enum:
              - RED
              - BLUE
              - YELLOW
              - PURPLE
              - GREEN
              - PINK
              - VIOLET
              - ORANGE
              - DARK_GREEN
              - CYAN
              - LAVENDER
              - DEEP_ORANGE
          required:
          - color
          additionalProperties: false
        externalId:
          anyOf:
          - type: string
          - type: 'null'
        releasesEnabled:
          type: boolean
        metadata:
          anyOf:
          - type: object
            propertyNames:
              type: string
            additionalProperties: {}
          - type: 'null'
        poolId:
          anyOf:
          - type: string
            pattern: ^[0-9a-zA-Z]{21}$
          - type: 'null'
        plan:
          type: object
          properties:
            id:
              type: string
            created:
              type: string
            updated:
              type: string
            projectId:
              type: string
            locked:
              default: false
              type: boolean
            name:
              type: string
            piecesFilterType:
              type: string
              enum:
              - NONE
              - ALLOWED
            pieces:
              type: array
              items:
                type: string
          required:
          - id
          - created
          - updated
          - projectId
          - locked
          - name
          - piecesFilterType
          - pieces
          additionalProperties: false
        analytics:
          type: object
          properties:
            totalUsers:
              type: number
            activeUsers:
              type: number
            totalFlows:
              type: number
            activeFlows:
              type: number
          required:
          - totalUsers
          - activeUsers
          - totalFlows
          - activeFlows
          additionalProperties: false
      required:
      - id
      - created
      - updated
      - ownerId
      - displayName
      - platformId
      - type
      - icon
      - releasesEnabled
      - plan
      - analytics
      additionalProperties: false
  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)