Skip to main content

Managing Clients

Clients represent the people or organizations you're doing design work for. Clients are scoped to your user account (not project-specific).

List Clients

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

Get a Client

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

Create a Client

curl -X POST https://beta.renovatr.app/api/v1/clients \
-H "X-API-KEY: your-api-key-here" \
-H "Content-Type: application/json" \
-d '{
"name": "Jane Smith",
"email": "jane@example.com",
"phone": "+1-555-0123",
"company": "Smith Interiors"
}'

Fields

FieldTypeRequiredDescription
namestringYesClient name
emailstringNoEmail address
phonestringNoPhone number
companystringNoCompany name
notesstringNoAdditional notes
note

Client personal information (name, email, phone) is encrypted at rest using AES-256-GCM.

Update a Client

curl -X PATCH https://beta.renovatr.app/api/v1/clients/5 \
-H "X-API-KEY: your-api-key-here" \
-H "Content-Type: application/json" \
-d '{ "email": "jane.smith@newdomain.com" }'

Delete a Client

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