Get Started
Endpoints
- Projects
- User Invitations
- Project Members
- Connections
- Flows
- Flow Runs
- Sample Data
- Pieces
- Project Releases
- Global Connections
- Git Sync
- Folders
- Flow Templates
- MCP Servers
- MCP pieces
Projects
Create Project
POST
/
v1
/
projects
Copy
Ask AI
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": {}
}'
Copy
Ask AI
{
"id": "<string>",
"created": "<string>",
"updated": "<string>",
"ownerId": "<string>",
"displayName": "<string>",
"notifyStatus": "NEVER",
"platformId": "<string>",
"externalId": "<string>",
"releasesEnabled": true,
"metadata": {},
"usage": {
"tasks": 123,
"aiCredits": 123,
"nextLimitResetDate": "<string>"
},
"plan": {
"id": "<string>",
"created": "<string>",
"updated": "<string>",
"projectId": "<string>",
"name": "<string>",
"piecesFilterType": "NONE",
"pieces": [
"<string>"
],
"tasks": 123,
"aiCredits": 123
},
"analytics": {
"totalUsers": 123,
"activeUsers": 123,
"totalFlows": 123,
"activeFlows": 123
}
}
Authorizations
Use your api key generated from the admin console
Body
application/json
Response
201 - application/json
Default Response
The response is of type object
.
Copy
Ask AI
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": {}
}'
Copy
Ask AI
{
"id": "<string>",
"created": "<string>",
"updated": "<string>",
"ownerId": "<string>",
"displayName": "<string>",
"notifyStatus": "NEVER",
"platformId": "<string>",
"externalId": "<string>",
"releasesEnabled": true,
"metadata": {},
"usage": {
"tasks": 123,
"aiCredits": 123,
"nextLimitResetDate": "<string>"
},
"plan": {
"id": "<string>",
"created": "<string>",
"updated": "<string>",
"projectId": "<string>",
"name": "<string>",
"piecesFilterType": "NONE",
"pieces": [
"<string>"
],
"tasks": 123,
"aiCredits": 123
},
"analytics": {
"totalUsers": 123,
"activeUsers": 123,
"totalFlows": 123,
"activeFlows": 123
}
}
Assistant
Responses are generated using AI and may contain mistakes.