Managing Projects

Projects are the top-level container in Renovatr. All deliverables, snags, invoices, and other resources belong to a project.

List Projects

curl https://beta.renovatr.app/api/v1/projects \
  -H "X-API-KEY: your-api-key-here"

Returns all projects you own or have been granted access to.

Get a Project

curl https://beta.renovatr.app/api/v1/projects/1 \
  -H "X-API-KEY: your-api-key-here"

Create a Project

curl -X POST https://beta.renovatr.app/api/v1/projects \
  -H "X-API-KEY: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Kitchen Renovation",
    "clientId": 5,
    "status": "active",
    "designFeeRate": 15
  }'

Fields

Field	Type	Required	Description
name	string	Yes	Project name
clientId	integer	No	Associated client ID
status	string	No	active, completed, or on_hold
designFeeRate	number	No	Design fee percentage (0–100)
currencySymbol	string	No	Currency symbol (1–5 chars, default $)
vatRate	number	No	VAT rate percentage (0–100, default 0)

Update a Project

curl -X PATCH https://beta.renovatr.app/api/v1/projects/1 \
  -H "X-API-KEY: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{ "status": "completed" }'

Delete a Project

curl -X DELETE https://beta.renovatr.app/api/v1/projects/1 \
  -H "X-API-KEY: your-api-key-here"

caution

Deleting a project permanently removes all associated deliverables, snags, invoices, attachments, and portal links. This action cannot be undone.

Project Settings

Project owners can update settings like currency symbol, VAT rate, and design fee rate:

curl -X PATCH https://beta.renovatr.app/api/v1/projects/1/settings \
  -H "X-API-KEY: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "currencySymbol": "€",
    "vatRate": 20,
    "designFeeRate": 12
  }'