Propaired Developer API

1. Get an API key

From your dashboard, go to Settings → Integrations → API Keys and create a key. It starts with pk_ and is shown once — copy it somewhere safe.

2. Create a lead

Send a lead to your CRM from any tool that can make an HTTP request. New leads run through the same pipeline as every other lead source — smart tagging, routing, and webhook delivery.

curl -X POST https://www.propaired.ai/api/public/leads \
  -H "Authorization: Bearer pk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Jamie",
    "last_name": "Rivera",
    "email": "jamie@example.com",
    "phone": "801-555-0100",
    "source": "website",
    "notes": "Interested in 3-bed homes in Draper"
  }'

Response

{
  "data": {
    "id": "b1e2...uuid",
    "first_name": "Jamie",
    "last_name": "Rivera",
    "email": "jamie@example.com",
    "status": "new",
    "lifecycle_stage": "lead",
    "created_at": "2026-07-21T18:00:00.000Z"
  }
}

3. Subscribe a webhook

Get a signed POST to your own endpoint whenever a lead is created or converted. Verify the X-Propaired-Signature header (HMAC-SHA256) against your webhook's secret. You can also create webhooks directly from Settings → Integrations → Webhooks.

curl -X POST https://www.propaired.ai/api/platform/webhooks \
  -H "Content-Type: application/json" \
  --cookie "<your dashboard session cookie>" \
  -d '{
    "name": "My integration",
    "url": "https://example.com/webhooks/propaired",
    "events": ["lead.created", "lead.converted"]
  }'

Full API reference

The full OpenAPI 3.1 spec for every public endpoint — import it into Postman, Insomnia, or any OpenAPI-compatible tool.