Skip to main content
POST
/
v1
/
projects
cURL
curl --request POST \
  --url https://cloud.activepieces.com/api/v1/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "externalId": "<string>",
  "metadata": {},
  "maxConcurrentJobs": 123,
  "globalConnectionExternalIds": [
    "<string>"
  ],
  "alertReceiverEmail": "jsmith@example.com"
}
'
{
  "id": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "ownerId": "<string>",
  "displayName": "<string>",
  "platformId": "<string>",
  "icon": {},
  "releasesEnabled": true,
  "plan": {
    "id": "<string>",
    "created": "<string>",
    "updated": "<string>",
    "projectId": "<string>",
    "locked": false,
    "name": "<string>",
    "pieces": [
      "<string>"
    ]
  },
  "analytics": {
    "totalUsers": 123,
    "activeUsers": 123,
    "totalFlows": 123,
    "activeFlows": 123
  },
  "maxConcurrentJobs": 123,
  "externalId": "<string>",
  "metadata": {},
  "poolId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://www.activepieces.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Use your api key generated from the admin console

Body

application/json
displayName
string
required
Pattern: ^[^./]+$
externalId
string | null
metadata
object
maxConcurrentJobs
number | null
globalConnectionExternalIds
string[]
alertReceiverEmail
string<email> | null
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Response

201 - application/json

Default Response

id
string
required
created
string
required
updated
string
required
ownerId
string
required
displayName
string
required
platformId
string
required
Pattern: ^[0-9a-zA-Z]{21}$
type
enum<string>
required
Available options:
TEAM,
PERSONAL
icon
object
required
releasesEnabled
boolean
required
plan
object
required
analytics
object
required
maxConcurrentJobs
number | null
externalId
string | null
metadata
object
poolId
string | null
Pattern: ^[0-9a-zA-Z]{21}$