/api/v1

API Documentation

Build custom integrations with the ProposalKit API. Access your proposals, customers, templates, and equipment data programmatically.

Available on the Business plan and above

Authentication

Authenticate your API requests using Bearer tokens. Generate API keys from your ProposalKit dashboard under Settings > API Keys.

Authorization: Bearer pk_live_your_api_key
pk_live_ for production
pk_test_ for testing

Endpoints

Proposals

GETPOSTPATCHDELETE
/api/v1/proposals

Create, read, update, and manage proposals programmatically. List proposals, get proposal details, and track status changes.

Customers

GETPOSTPATCHDELETE
/api/v1/customers

Manage your customer database. Create new customers, update contact information, and retrieve customer history.

Templates

GETPOSTPATCH
/api/v1/templates

Access and manage HVAC proposal templates. List available templates, get template details, and create custom templates.

Equipment

GET
/api/v1/equipment

Browse the HVAC equipment catalog. Search for equipment by type, brand, or model. Get pricing and specification details.

Rate Limits

API requests are rate limited to ensure fair usage and platform stability.

100
Requests per minute
5,000
Requests per hour
50,000
Requests per day

Rate limit headers are included in every response: X-RateLimit-Remaining, X-RateLimit-Reset

Quick Start Example

terminal
curl -X GET https://api.hvacproposalkit.com/v1/proposals \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json"

# Response
{
  "data": [
    {
      "id": "prop_abc123",
      "customer_name": "John Smith",
      "job_type": "AC Installation",
      "status": "accepted",
      "total": 8450.00,
      "created_at": "2026-02-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 142
  }
}

Ready to integrate?

API access is available on the Business plan. Start your free trial to get your API keys and explore the full documentation.