Activepieces Variables API
The variables API from Activepieces — 2 operation(s) for variables.
The variables API from Activepieces — 2 operation(s) for variables.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/activepieces:activepieces-variables-api"
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.
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: 3.2.0
info:
title: Activepieces Documentation Variables API
version: 0.0.0
servers:
- url: https://cloud.activepieces.com/api
description: Production Server
tags:
- name: Variables
paths:
/v1/variables:
post:
tags:
- Variables
description: Create a project variable. Fails if a variable with the same name already exists.
requestBody:
content:
application/json:
schema:
type: object
properties:
projectId:
type: string
name:
type: string
minLength: 1
pattern: ^[a-zA-Z0-9_]+$
value:
type: string
minLength: 1
metadata:
type: object
propertyNames:
type: string
additionalProperties: {}
required:
- projectId
- name
- value
required: true
security:
- apiKey: []
responses:
'201':
description: Default Response
content:
application/json:
schema:
$ref: '#/components/schemas/variable'
summary: Create variables
x-summary-source: derived
operationId: postV1Variables
x-operation-id-source: derived
get:
tags:
- Variables
description: List project variables
parameters:
- schema:
type: string
in: query
name: projectId
required: true
- schema:
type: string
in: query
name: cursor
required: false
- schema:
type: number
in: query
name: limit
required: false
- schema:
type: string
in: query
name: name
required: false
security:
- apiKey: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/variable'
next:
anyOf:
- type: string
- type: 'null'
previous:
anyOf:
- type: string
- type: 'null'
required:
- data
additionalProperties: false
summary: Get variables
x-summary-source: derived
operationId: getV1Variables
x-operation-id-source: derived
/v1/variables/{id}:
post:
tags:
- Variables
description: Update a project variable value or metadata. Name cannot be changed.
requestBody:
content:
application/json:
schema:
type: object
properties:
value:
type: string
minLength: 1
metadata:
type: object
propertyNames:
type: string
additionalProperties: {}
parameters:
- schema:
type: string
pattern: ^[0-9a-zA-Z]{21}$
in: path
name: id
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
$ref: '#/components/schemas/variable'
summary: Create variables by id
x-summary-source: derived
operationId: postV1VariablesById
x-operation-id-source: derived
delete:
tags:
- Variables
description: Delete a project variable
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 variables by id
x-summary-source: derived
operationId: deleteV1VariablesById
x-operation-id-source: derived
components:
schemas:
variable:
$schema: https://json-schema.org/draft/2020-12/schema
$id: '#/components/schemas/variable'
type: object
properties:
id:
type: string
created:
type: string
updated:
type: string
name:
type: string
projectId:
type: string
platformId:
type: string
ownerId:
anyOf:
- type: string
- type: 'null'
owner:
anyOf:
- $ref: '#/components/schemas/user'
- type: 'null'
metadata:
anyOf:
- type: object
propertyNames:
type: string
additionalProperties: {}
- type: 'null'
required:
- id
- created
- updated
- name
- projectId
- platformId
additionalProperties: false
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
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