Projects
Create Project
- Documentation
- Deploy
- Develop Pieces
- API
- Discord
- Pieces
- Handbook
- Overview
- Projects
- Project Members
- Connections
- Flows
- Pieces
- Git Sync
Get Started
Endpoints
Projects
Create Project
POST
/
v1
/
projects
/
object
*
displayName
string
*
displayName
Required
string
externalId
string
externalId
string
curl --request POST \
--url https://cloud.activepieces.com/api/v1/projects/ \
--header 'Content-Type: application/json' \
--data '{
"displayName": "<string>",
"externalId": "<string>"
}'
{
"id": "<string>",
"created": "<string>",
"updated": "<string>",
"ownerId": "<string>",
"displayName": "<string>",
"notifyStatus": "NEVER",
"type": "PLATFORM_MANAGED",
"platformId": "<string>",
"externalId": "<string>",
"plan": {
"id": "<string>",
"created": "<string>",
"updated": "<string>",
"projectId": "<string>",
"stripeSubscriptionId": "<string>",
"subscriptionStartDatetime": "<string>",
"flowPlanName": "<string>",
"minimumPollingInterval": 123,
"connections": 123,
"teamMembers": 123,
"tasks": 123,
"tasksPerDay": 123
},
"usage": {
"id": "<string>",
"created": "<string>",
"updated": "<string>",
"projectId": "<string>",
"consumedTasks": 123,
"connections": 123,
"teamMembers": 123,
"consumedTasksToday": 123,
"nextResetDatetime": "<string>"
}
}
Body
application/json
displayName
string
requiredexternalId
string
Response
201 - application/json
id
string
requiredcreated
string
requiredupdated
string
requiredownerId
string
requireddisplayName
string
requirednotifyStatus
required
Available options:
NEVER
type
required
Available options:
PLATFORM_MANAGED
platformId
string
externalId
string
plan
object
requiredplan.id
string
requiredplan.created
string
requiredplan.updated
string
requiredplan.projectId
string
requiredplan.stripeSubscriptionId
string | null
plan.subscriptionStartDatetime
string
requiredplan.flowPlanName
string
requiredplan.minimumPollingInterval
number
requiredplan.connections
number
requiredplan.teamMembers
number
requiredplan.tasks
number
requiredplan.tasksPerDay
number | null
usage
object
requiredusage.id
string
requiredusage.created
string
requiredusage.updated
string
requiredusage.projectId
string
requiredusage.consumedTasks
number
requiredusage.connections
number
requiredusage.teamMembers
number
requiredusage.consumedTasksToday
number
requiredusage.nextResetDatetime
string
requiredcurl --request POST \
--url https://cloud.activepieces.com/api/v1/projects/ \
--header 'Content-Type: application/json' \
--data '{
"displayName": "<string>",
"externalId": "<string>"
}'
{
"id": "<string>",
"created": "<string>",
"updated": "<string>",
"ownerId": "<string>",
"displayName": "<string>",
"notifyStatus": "NEVER",
"type": "PLATFORM_MANAGED",
"platformId": "<string>",
"externalId": "<string>",
"plan": {
"id": "<string>",
"created": "<string>",
"updated": "<string>",
"projectId": "<string>",
"stripeSubscriptionId": "<string>",
"subscriptionStartDatetime": "<string>",
"flowPlanName": "<string>",
"minimumPollingInterval": 123,
"connections": 123,
"teamMembers": 123,
"tasks": 123,
"tasksPerDay": 123
},
"usage": {
"id": "<string>",
"created": "<string>",
"updated": "<string>",
"projectId": "<string>",
"consumedTasks": 123,
"connections": 123,
"teamMembers": 123,
"consumedTasksToday": 123,
"nextResetDatetime": "<string>"
}
}