VUZDevelopers

Create a new project

POST
/projects

Creates a new project for tracking work, documents, and financials.

Project Fields:

  • name: Project name (required)
  • description: Project description
  • status: Project status (draft, active, on_hold, completed, cancelled)
  • priority: Priority level (low, medium, high, urgent)
  • startDate/endDate: Project timeline
  • budget: Planned budget
  • estimatedValue: Expected total value
  • category: Project category (free text)
  • tags: Array of tags for filtering
  • clientId: Optional linked client

Use Cases:

  • Track construction/renovation projects
  • Manage ongoing client engagements
  • Group related documents and invoices

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/projects" \  -H "Content-Type: application/json" \  -d '{    "name": "Website Redesign"  }'
{  "id": "string",  "name": "string",  "description": "string",  "status": "draft",  "priority": "low",  "startDate": "string",  "endDate": "string",  "budget": "string",  "estimatedValue": "string",  "actualValue": "string",  "currency": "string",  "category": "string",  "tags": [    "string"  ],  "notes": "string",  "metadata": {},  "businessId": "string",  "client": {    "id": "string",    "name": "string",    "email": "string",    "phone": "string"  },  "documentsCount": 0,  "attachmentsCount": 0,  "workOrdersCount": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "creatorName": "string"}