PropGap Pro Open API

Authentication

All API endpoints accept your access key either as a query parameter or an HTTP header. The key format is PG-XXXXXXXX.

# Query parameter (easiest for testing)
GET /api/pro/export/[jobId]?accessKey=PG-YOURKEY

# Header (recommended for production)
GET /api/pro/export/[jobId]
x-access-key: PG-YOURKEY

Parameters

Example Request

curl "https://propgap.ai/api/pro/export/YOUR-JOB-UUID?accessKey=PG-YOURKEY"

Response Schema

{
  "meta": {
    "jobId": "uuid",
    "firmName": "Smith & Associates LLC",
    "totalProperties": 20,
    "successCount": 15,
    "exportedAt": "2026-03-25T12:00:00Z",
    "disclaimer": "Tax rates are statewide averages..."
  },
  "results": [
    {
      "address": "123 Main St, Newark, NJ 07102",
      "assessedValue": 450000,
      "status": "success",           // success | no_gap | no_comps | error
      "taxGap": 3200,                // annual tax overpayment ($)
      "medianCompMV": 380000,        // median comparable sale price
      "compCount": 8,
      "outcome": "filed",            // filed | won | settled | denied | withdrew | pending
      "outcomeNotes": "Hearing 4/10",
      "shareUrl": "https://propgap.ai/pro/share/uuid",
      "evidenceKitUrl": "https://propgap.ai/api/pdf/evidence-packet?auditId=uuid&proKey=PG-KEY",
      "errorMessage": null
    }
  ]
}

curl "https://propgap.ai/api/pro/analytics?accessKey=PG-YOURKEY"

{
  "firm": { "name": "Smith LLC", "status": "active", "memberSince": "2026-01-15" },
  "totals": { "properties": 200, "gapsFound": 145, "totalGap": 580000, "batches": 12 },
  "outcomes": { "won": 40, "settled": 25, "filed": 60, "denied": 8, "withdrew": 5, "pending": 7 },
  "winRate": 72,
  "estimatedRecovered": 225000,
  "byState": { "NJ": { "gapsFound": 90, "totalGap": 360000, "won": 28, "settled": 18 } },
  "monthlyTrend": [{ "month": "2026-01", "batches": 2, "gapsFound": 18, "totalGap": 72000 }]
}

curl "https://propgap.ai/api/pro/batch/history?accessKey=PG-YOURKEY"

# Response
{
  "jobs": [
    {
      "id": "uuid",
      "created_at": "2026-03-20T10:00:00Z",
      "status": "completed",
      "total_count": 20,
      "completed_count": 20,
      "success_count": 15
    }
  ],
  "totalGapByJob": { "uuid": 48000 }
}

curl -X PATCH "https://propgap.ai/api/pro/batch/outcome" \
  -H "Content-Type: application/json" \
  -d '{
    "resultId": "uuid",
    "accessKey": "PG-YOURKEY",
    "outcome": "won",
    "notes": "Board reduced AV from $450k to $390k"
  }'

# Valid outcomes: filed | won | settled | denied | withdrew | pending

curl "https://propgap.ai/api/pro/pipeline?accessKey=PG-YOURKEY"

# Response
{
  "results": [
    {
      "id": "uuid",
      "job_id": "uuid",
      "address": "123 Main St, Newark, NJ 07102",
      "assessed_value": 450000,
      "tax_gap": 3200,
      "outcome": "filed",
      "filed_date": "2026-02-15",
      "hearing_date": "2026-04-10",
      "decision_date": null,
      "tax_savings_realized": null,
      "batchLabel": "March 2026 Upload"
    }
  ]
}

curl "https://propgap.ai/api/pro/portfolio?accessKey=PG-YOURKEY"

# Response
{
  "stats": {
    "total": 200,
    "gapCount": 145,
    "totalGap": 580000,
    "realizedSavings": 225000
  },
  "topProperties": [ /* top 50 by tax_gap, same shape as pipeline results */ ],
  "atRisk": [ /* hearing_date within 14 days, no won/settled/denied outcome */ ]
}

curl "https://propgap.ai/api/pro/batch/progress?accessKey=PG-YOURKEY"

# Response (while processing)
{
  "job": {
    "id": "uuid",
    "status": "processing",   // processing | completed | failed
    "totalCount": 20,
    "completedCount": 12,
    "pct": 60
  }
}

# Response (no active job)
{ "job": null }

curl -X PATCH "https://propgap.ai/api/pro/batch/archive" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": "uuid",
    "accessKey": "PG-YOURKEY",
    "archived": true
  }'

# Response
{ "ok": true }

curl -X PATCH "https://propgap.ai/api/pro/batch/internal-notes" \
  -H "Content-Type: application/json" \
  -d '{
    "resultId": "uuid",
    "accessKey": "PG-YOURKEY",
    "notes": "Owner prefers email. Deadline April 1."
  }'

# Response
{ "ok": true }

curl -X POST "https://propgap.ai/api/pro/share/intent" \
  -H "Content-Type: application/json" \
  -d '{
    "resultId": "uuid",
    "name": "Jane Smith",
    "email": "jane@example.com",
    "phone": "201-555-1234"   // optional
  }'

# Response (first submission)
{ "ok": true }

# Response (duplicate)
{ "ok": true, "alreadySubmitted": true }

Zapier / Make Integration

No native Zapier app yet — use the Webhook trigger pattern with the export endpoint. Here’s a common setup:

1. In your CRM (Clio, MyCase, etc.), create an automation on new matter creation.
2. Add a webhook step that calls GET /api/pro/export/[jobId] with your access key.
3. Map the taxGap, shareUrl, and evidenceKitUrl fields to your matter record.
4. Set up a second webhook to PATCH the outcome back to PropGap when you mark a matter resolved.

Rate Limits & SLA