Activepieces home pagelight logodark logo
  • GitHub
  • Pieces
  • Get Started
  • Get Started
Documentation
Develop Pieces
Embedding
API Reference
Deploy
Handbook
Get Started
  • Overview
Endpoints
  • Projects
    • Project Schema
    • POST
      Create Project
    • POST
      Update Project
    • GET
      List 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

Project Schema

The schema is of type object.

Suggest editsRaise issue
OverviewCreate Project
websitegithubdiscord
Powered by Mintlify
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.