Integration

Housecall Pro

Connect Housecall Pro customer and field-service records to phone workflows.

Description

AIM AI can be configured to work with selected Housecall Pro customers, jobs, estimates, and invoices. Company access, scheduling rules, dispatch boundaries, and write permissions are confirmed before implementation.

Authentication

A Housecall Pro API key for the approved company is required.
Exact company records and approved actions are confirmed during workflow scoping.

Supported Actions (57)

These are the operations this integration can perform after the required credentials and permissions are approved.

Disable Application
Enable Application
List Checklists
Create Customer Address
Get Customer Address
List Customer Addresses
Create Customer
List Customers
Update Customer
List Employees
Approve Estimate Options
Create Estimate Option Link
Create Estimate Option Note
Decline Estimate Options
Update Estimate Option Schedule
Create Estimate
Get Event
Get Invoice
Get Invoice Preview
List Invoices
Delete Job Appointment
List Job Appointments
Update Job Dispatch
Bulk Update Job Input Materials
List Job Invoices
List Job Line Items
Create Job Link
Delete Job Note
Delete Job Schedule
Add Job Tag
Delete Job Tag
Update Job Type
Create Job
Create Job Attachment
List Jobs
Lock Job
Lock Jobs
Create Lead Source
List Lead Sources
Update Lead Source
Convert Lead
Create Lead
Get Lead
List Leads
Delete Material Category
List Material Categories
Create Material
Delete Material
List Materials
List Price Book Services
Delete Price Form
Get Price Form
List Price Forms
Update Price Form
Get Company Schedule Availability
Update Company Schedule Availability
Update Tag

Examples

Use these representative payloads as a technical starting point, then replace the sample values with the approved workflow data.

Tags

Representative workflow configuration for Tags.

JSON

{
  "automationType": "housecallpro",
  "nodeId": "housecallpro-list-customers-001",
  "nodeParams": {
    "action": "list_customers",
    "params": {
      "apiKey": "your-api-key",
      "page": 1,
      "page_size": 50
    }
  }
}

Housecall Pro - Delete Customer Address

Representative workflow configuration for Housecall Pro - Delete Customer Address.

JSON

{
  "automationType": "housecallpro",
  "nodeId": "housecallpro-delete-address-001",
  "nodeParams": {
    "action": "delete_customer_address",
    "params": {
      "apiKey": "your-api-key",
      "customer_id": "customer-123",
      "address_id": "address-456"
    }
  }
}

Housecall Pro - Update Estimate

Representative workflow configuration for Housecall Pro - Update Estimate.

JSON

{
  "automationType": "housecallpro",
  "nodeId": "housecallpro-update-estimate-001",
  "nodeParams": {
    "action": "update_estimate",
    "params": {
      "apiKey": "your-api-key",
      "id": "estimate-123",
      "line_items": [
        {
          "name": "Pipe Repair",
          "quantity": 1,
          "unit_price": 18000
        }
      ]
    }
  }
}

Housecall Pro - Update Job Invoice

Representative workflow configuration for Housecall Pro - Update Job Invoice.

JSON

{
  "automationType": "housecallpro",
  "nodeId": "housecallpro-update-invoice-001",
  "nodeParams": {
    "action": "update_job_invoice",
    "params": {
      "apiKey": "your-api-key",
      "id": "invoice-123",
      "line_items": [
        {
          "name": "Pipe Repair",
          "quantity": 1,
          "unit_price": 18000
        }
      ]
    }
  }
}

Housecall Pro - List Lead Sources

Representative workflow configuration for Housecall Pro - List Lead Sources.

JSON

{
  "automationType": "housecallpro",
  "nodeId": "housecallpro-list-lead-sources-001",
  "nodeParams": {
    "action": "list_lead_sources",
    "params": {
      "apiKey": "your-api-key"
    }
  }
}

Housecall Pro - Get Company Info

Representative workflow configuration for Housecall Pro - Get Company Info.

JSON

{
  "automationType": "housecallpro",
  "nodeId": "housecallpro-get-company-001",
  "nodeParams": {
    "action": "get_company",
    "params": {
      "apiKey": "your-api-key"
    }
  }
}

Housecall Pro - Update Tag

Representative workflow configuration for Housecall Pro - Update Tag.

JSON

{
  "automationType": "housecallpro",
  "nodeId": "housecallpro-update-tag-001",
  "nodeParams": {
    "action": "update_tag",
    "params": {
      "apiKey": "your-api-key",
      "id": "tag-123",
      "name": "Premium VIP Customer",
      "color": "#FFD700"
    }
  }
}

Housecall Pro - Get Payment

Representative workflow configuration for Housecall Pro - Get Payment.

JSON

{
  "automationType": "housecallpro",
  "nodeId": "housecallpro-get-payment-001",
  "nodeParams": {
    "action": "get_payment",
    "params": {
      "apiKey": "your-api-key",
      "id": "payment-123"
    }
  }
}