Developer

REST API & Webhooks

Programmatically fetch your commercial intent signals or automatically pipe them into GoHighLevel, HubSpot, or Salesforce.

Authentication

All endpoints require an active API Key. You can pass your API key via the Authorization header or via the api_key query parameter.

Authorization: Bearer YOUR_API_KEY

Contact support to generate a long-lived API key for your account.

Endpoints

GET/api/v1/contracts

Returns a list of all your active geographical contracts and their raw configuration JSONs.

Example Response

{
  "data": [
    {
      "module": "leaddeed-fic",
      "contractName": "acme_corp_contract",
      "details": {
        "counties": ["Pinellas", "Hillsborough"],
        "delivery": {
          "email_to": ["ceo@acmecorp.com"]
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "client_email": "ceo@acmecorp.com"
  }
}

GET/api/v1/deliveries

Returns all historical deliveries and secure URLs to download your datasets.

Query Parameters:
- limit (default 50)
- module (e.g. leaddeed-fic, leaddeed-permits)

Example Response

{
  "data": [
    {
      "module": "leaddeed-fic",
      "contractName": "acme_corp_contract",
      "fileName": "LeadFlow_Output_2026-07-16..2026-07-16.xlsx",
      "fullPath": "https://data.ayrianna.com/leaddeed-fic/...xlsx",
      "modifiedAt": 1713294821000
    }
  ],
  "meta": {
    "total_returned": 1,
    "client_email": "ceo@acmecorp.com"
  }
}

Webhooks (Automated CRM Push)

We can automatically push daily signals directly into your CRM (GoHighLevel, HubSpot, Salesforce) as soon as our agents generate them.

Simply email support with your CRM's webhook endpoint URL. We will add a webhook_url block to your contract profile. Each time new leads are extracted, LeadDeed will fire a POST request to your URL.

Webhook Payload Example

{
  "module": "leaddeed-fic",
  "contractName": "acme_corp_contract",
  "latest_file_url": "https://data.ayrianna.com/leaddeed-fic/...xlsx",
  "latest_file_name": "LeadFlow_Output_2026-07-16..2026-07-16.xlsx",
  "metadata": { ... } // your geographical targeting data
}