Planned

API Documentation

A public RESTful API for PaintQuote Pro is planned, to let you create quotes, manage customers, and automate your workflow. It isn't available yet — here's a preview of the design.

Developer-Friendly API (Planned)

RESTful API

Simple, predictable REST endpoints

OAuth 2.0

Secure authentication flow

Webhooks

Real-time event notifications

Rate Limiting

1000 requests/hour per API key

Data Security

TLS 1.3 encryption for all requests

Batch Operations

Process multiple quotes efficiently

Planned Quick Start

This is a preview of how getting started with the API is planned to work once it ships

1

Get Your API Key (Planned)

Once the API ships, you'll sign in to your dashboard and generate a key from Settings → API Keys.

pk_example_1234567890abcdefExample format
2

Install SDK (Planned, Optional)

Official SDKs are planned for these languages — package names below are illustrative and not published yet, so please don't install them.

JavaScript
npm install @paintquotepro/sdk
Python
pip install paintquotepro
PHP
composer require paintquotepro/sdk
Ruby
gem install paintquotepro
3

Make Your First Request

Create a quote using our REST API

curl -X POST https://api.www.paintquoteapp.com/v1/quotes \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_name": "John Smith",
    "address": "123 Main St",
    "rooms": ["living_room", "bedroom"],
    "sqft": 1200
  }'

API Endpoints (Planned)

These endpoints are not live yet — this is a preview of what's planned.

Core Endpoints

GET
/api/v1/quotes

List all quotes

POST
/api/v1/quotes

Create a new quote

GET
/api/v1/quotes/{id}

Get quote details

PUT
/api/v1/quotes/{id}

Update a quote

POST
/api/v1/quotes/{id}/send

Send quote to customer

GET
/api/v1/customers

List customers

Common Use Cases

CRM Integration

Sync quotes with your customer management system

Automatically create quotes when new leads arrive

Accounting Sync

Push approved quotes to your accounting software

Create invoices in QuickBooks when quotes are accepted

Custom Workflows

Build approval chains and automation

Route high-value quotes for manager approval

Mobile Apps

Create custom mobile experiences

Build a branded app for your painting crews

Authentication

Bearer Token Authentication

All API requests must include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Keep your API key secure. Never expose it in client-side code or public repositories.

Use environment variables to store your API key in production applications.

Rotate keys regularly and revoke unused keys from your dashboard.

Developer Resources

Full Reference

Complete API documentation with examples

SDKs & Libraries

Official client libraries for all platforms

Postman Collection

Import our API collection for testing

Want to Build on the API?

It's not available yet — reach out and we'll let you know when it ships