Activepieces Global Connections API
The global-connections API from Activepieces — 2 operation(s) for global-connections.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/activepieces:activepieces-global-connections-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
openapi: 3.2.0
info:
title: Activepieces Documentation Global Connections API
version: 0.0.0
servers:
- url: https://cloud.activepieces.com/api
description: Production Server
tags:
- name: global-connections
paths:
/v1/global-connections:
post:
tags:
- global-connections
requestBody:
content:
application/json:
schema:
anyOf:
- type: object
properties:
displayName:
type: string
pieceName:
type: string
metadata:
type: object
propertyNames:
type: string
additionalProperties: {}
pieceVersion:
type: string
type:
type: string
enum:
- SECRET_TEXT
value:
type: object
properties:
type:
type: string
enum:
- SECRET_TEXT
secret_text:
type: string
minLength: 1
required:
- type
- secret_text
scope:
type: string
enum:
- PLATFORM
projectIds:
type: array
items:
type: string
externalId:
type: string
preSelectForNewProjects:
type: boolean
required:
- displayName
- pieceName
- type
- value
- scope
- projectIds
- type: object
properties:
displayName:
type: string
pieceName:
type: string
metadata:
type: object
propertyNames:
type: string
additionalProperties: {}
pieceVersion:
type: string
type:
type: string
enum:
- OAUTH2
value:
type: object
properties:
client_id:
type: string
minLength: 1
code:
type: string
minLength: 1
code_challenge:
type: string
scope:
type: string
authorization_method:
type: string
enum:
- HEADER
- BODY
client_secret:
type: string
minLength: 1
grant_type:
type: string
enum:
- authorization_code
- client_credentials
props:
type: object
propertyNames:
type: string
additionalProperties: {}
redirect_url:
type: string
minLength: 1
type:
type: string
enum:
- OAUTH2
required:
- client_id
- code
- scope
- client_secret
- redirect_url
- type
scope:
type: string
enum:
- PLATFORM
projectIds:
type: array
items:
type: string
externalId:
type: string
preSelectForNewProjects:
type: boolean
required:
- displayName
- pieceName
- type
- value
- scope
- projectIds
- type: object
properties:
displayName:
type: string
pieceName:
type: string
metadata:
type: object
propertyNames:
type: string
additionalProperties: {}
pieceVersion:
type: string
type:
type: string
enum:
- CLOUD_OAUTH2
value:
type: object
properties:
client_id:
type: string
minLength: 1
code:
type: string
minLength: 1
code_challenge:
type: string
scope:
type: string
authorization_method:
type: string
enum:
- HEADER
- BODY
props:
type: object
propertyNames:
type: string
additionalProperties: {}
type:
type: string
enum:
- CLOUD_OAUTH2
required:
- client_id
- code
- scope
- type
scope:
type: string
enum:
- PLATFORM
projectIds:
type: array
items:
type: string
externalId:
type: string
preSelectForNewProjects:
type: boolean
required:
- displayName
- pieceName
- type
- value
- scope
- projectIds
- type: object
properties:
displayName:
type: string
pieceName:
type: string
metadata:
type: object
propertyNames:
type: string
additionalProperties: {}
pieceVersion:
type: string
type:
type: string
enum:
- PLATFORM_OAUTH2
value:
type: object
properties:
client_id:
type: string
minLength: 1
code:
type: string
minLength: 1
code_challenge:
type: string
scope:
type: string
authorization_method:
type: string
enum:
- HEADER
- BODY
props:
type: object
propertyNames:
type: string
additionalProperties: {}
type:
type: string
enum:
- PLATFORM_OAUTH2
redirect_url:
type: string
minLength: 1
required:
- client_id
- code
- scope
- type
- redirect_url
scope:
type: string
enum:
- PLATFORM
projectIds:
type: array
items:
type: string
externalId:
type: string
preSelectForNewProjects:
type: boolean
required:
- displayName
- pieceName
- type
- value
- scope
- projectIds
- type: object
properties:
displayName:
type: string
pieceName:
type: string
metadata:
type: object
propertyNames:
type: string
additionalProperties: {}
pieceVersion:
type: string
type:
type: string
enum:
- BASIC_AUTH
value:
type: object
properties:
username:
type: string
minLength: 1
password:
type: string
minLength: 1
type:
type: string
enum:
- BASIC_AUTH
required:
- username
- password
- type
scope:
type: string
enum:
- PLATFORM
projectIds:
type: array
items:
type: string
externalId:
type: string
preSelectForNewProjects:
type: boolean
required:
- displayName
- pieceName
- type
- value
- scope
- projectIds
- type: object
properties:
displayName:
type: string
pieceName:
type: string
metadata:
type: object
propertyNames:
type: string
additionalProperties: {}
pieceVersion:
type: string
type:
type: string
enum:
- CUSTOM_AUTH
value:
type: object
properties:
type:
type: string
enum:
- CUSTOM_AUTH
props:
type: object
propertyNames:
type: string
additionalProperties: {}
required:
- type
- props
scope:
type: string
enum:
- PLATFORM
projectIds:
type: array
items:
type: string
externalId:
type: string
preSelectForNewProjects:
type: boolean
required:
- displayName
- pieceName
- type
- value
- scope
- projectIds
- type: object
properties:
displayName:
type: string
pieceName:
type: string
metadata:
type: object
propertyNames:
type: string
additionalProperties: {}
pieceVersion:
type: string
type:
type: string
enum:
- NO_AUTH
value:
type: object
properties:
type:
type: string
enum:
- NO_AUTH
required:
- type
scope:
type: string
enum:
- PLATFORM
projectIds:
type: array
items:
type: string
externalId:
type: string
preSelectForNewProjects:
type: boolean
required:
- displayName
- pieceName
- type
- value
- scope
- projectIds
security:
- apiKey: []
responses:
'201':
description: Default Response
content:
application/json:
schema:
$ref: '#/components/schemas/app-connection'
summary: Create global connections
x-summary-source: derived
operationId: postV1GlobalConnections
x-operation-id-source: derived
get:
tags:
- global-connections
parameters:
- schema:
type: string
in: query
name: cursor
required: false
- schema:
type: string
enum:
- PROJECT
- PLATFORM
in: query
name: scope
required: false
- schema:
type: string
in: query
name: pieceName
required: false
- schema:
type: string
in: query
name: displayName
required: false
- schema:
type: array
items:
type: string
enum:
- ACTIVE
- MISSING
- ERROR
in: query
name: status
required: true
- schema:
type: number
in: query
name: limit
required: false
security:
- apiKey: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/app-connection'
next:
anyOf:
- type: string
- type: 'null'
previous:
anyOf:
- type: string
- type: 'null'
required:
- data
additionalProperties: false
summary: Get global connections
x-summary-source: derived
operationId: getV1GlobalConnections
x-operation-id-source: derived
/v1/global-connections/{id}:
post:
tags:
- global-connections
requestBody:
content:
application/json:
schema:
type: object
properties:
displayName:
type: string
minLength: 1
projectIds:
type: array
items:
type: string
metadata:
type: object
propertyNames:
type: string
additionalProperties: {}
preSelectForNewProjects:
type: boolean
required:
- displayName
required: true
parameters:
- schema:
type: string
pattern: ^[0-9a-zA-Z]{21}$
in: path
name: id
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
summary: Create global connections by id
x-summary-source: derived
operationId: postV1GlobalConnectionsById
x-operation-id-source: derived
delete:
tags:
- global-connections
parameters:
- schema:
type: string
pattern: ^[0-9a-zA-Z]{21}$
in: path
name: id
required: true
security:
- apiKey: []
responses:
'204':
description: Default Response
content:
application/json:
schema:
not: {}
summary: Delete global connections by id
x-summary-source: derived
operationId: deleteV1GlobalConnectionsById
x-operation-id-source: derived
components:
schemas:
user:
$schema: https://json-schema.org/draft/2020-12/schema
$id: '#/components/schemas/user'
type: object
properties:
id:
type: string
email:
type: string
firstName:
type: string
status:
type: string
enum:
- ACTIVE
- INACTIVE
externalId:
anyOf:
- type: string
- type: 'null'
platformId:
anyOf:
- type: string
- type: 'null'
platformRole:
type: string
enum:
- ADMIN
- MEMBER
- OPERATOR
lastName:
type: string
created:
type: string
updated:
type: string
lastActiveDate:
anyOf:
- type: string
- type: 'null'
imageUrl:
anyOf:
- type: string
- type: 'null'
required:
- id
- email
- firstName
- status
- platformRole
- lastName
- created
- updated
additionalProperties: false
app-connection:
$schema: https://json-schema.org/draft/2020-12/schema
$id: '#/components/schemas/app-connection'
type: object
properties:
id:
type: string
created:
type: string
updated:
type: string
externalId:
type: string
displayName:
type: string
type:
type: string
enum:
- OAUTH2
- PLATFORM_OAUTH2
- CLOUD_OAUTH2
- SECRET_TEXT
- BASIC_AUTH
- CUSTOM_AUTH
- NO_AUTH
pieceName:
type: string
projectIds:
type: array
items:
type: string
pattern: ^[0-9a-zA-Z]{21}$
platformId:
anyOf:
- type: string
- type: 'null'
scope:
type: string
enum:
- PROJECT
- PLATFORM
status:
type: string
enum:
- ACTIVE
- MISSING
- ERROR
ownerId:
anyOf:
- type: string
- type: 'null'
owner:
anyOf:
- $ref: '#/components/schemas/user'
- type: 'null'
metadata:
anyOf:
- type: object
propertyNames:
type: string
additionalProperties: {}
- type: 'null'
flowIds:
anyOf:
- type: array
items:
type: string
pattern: ^[0-9a-zA-Z]{21}$
- type: 'null'
pieceVersion:
type: string
preSelectForNewProjects:
type: boolean
usingSecretManager:
type: boolean
required:
- id
- created
- updated
- externalId
- displayName
- type
- pieceName
- projectIds
- scope
- status
- pieceVersion
- preSelectForNewProjects
- usingSecretManager
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