Housecall Pro API
Housecall Pro is field service management software used by home service contractors (HVAC, plumbing, electrical, cleaning, pest control) to run their businesses end-to-end. An unofficial API lets you programmatically pull customer records, service locations, jobs and schedules, estima
What is Housecall Pro?
Housecall Pro is a cloud platform for home and field service businesses that centralizes scheduling, dispatch, customer management, job execution, and payments. Teams use Housecall Pro to book appointments, manage pricebooks and estimates, send invoices, process payments, track memberships/service plans, communicate with customers, capture field photos and notes, and reconcile work across office and field.
Core product areas include:
- Scheduling & Dispatch (e.g., calendar, assignment, arrival windows, routeing)
- CRM & Customer Management (e.g., customer profiles, service locations, tags)
- Estimates & Invoicing (e.g., pricebook, line items, taxes, discounts)
- Payments & Financing (e.g., card capture, ACH, tips, deposits)
- Service Plans/Memberships (e.g., recurring visits, benefits, renewals)
- Communication & Automations (e.g., email/SMS, reminders, review requests)
- Time Tracking & Team Management (e.g., technician time, roles, permissions)
- Attachments & Field Artifacts (e.g., photos, documents, signatures)
Common data entities:
- Customers and Service Locations
- Jobs/Work Orders and Statuses
- Estimates, Invoices, Line Items, Taxes, Discounts
- Payments (card, cash, check, ACH) and Fees
- Pricebook Items (services, parts, bundles)
- Employees/Technicians and Schedules
- Memberships/Service Plans
- Notes, Photos, Attachments, Messages
The Housecall Pro Integration Challenge
Field service teams rely on Housecall Pro daily, but turning portal-based workflows into API-driven automation is non-trivial:
- Calendar-first UX: Scheduling, dispatch, and arrival windows are optimized for the web/mobile apps; data is spread across views and exports
- Role-based permissions: Office vs. field roles, technician visibility, and customer privacy must be respected programmatically
- Payments and PCI constraints: Tokenized card flows, refunds, and reconciliation require careful handling
- Pricebook complexity: Services, parts, bundles, and taxes/discounts vary by market and membership benefits
- Membership cycles: Recurring visits, renewals, and entitlements create time-based logic for automation
- Attachments and media: Photos, documents, and signatures need reliable upload/download flows
How Supergood Creates Housecall Pro APIs
Supergood reverse-engineers authenticated browser flows and network interactions to deliver a resilient API endpoint layer for your Housecall Pro tenant.
- Handles username/password and 2FA/MFA when enabled; operates behind SSO/OAuth where applicable
- Maintains session continuity with automated refresh and change detection
- Normalizes responses so you can integrate once and rely on consistent objects across modules
- Aligns with customer entitlements and role-based permissions to ensure compliant access
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your modules, licensing, and authentication model.
- Supergood Builds and Validates Your API
We deliver a hardened Housecall Pro adapter tailored to your workflows and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as Housecall Pro evolves.
API Endpoints
Authentication
/sessionsEstablish a session using credentials. Supergood manages MFA/2FA and SSO/OAuth when enabled. Returns a short-lived auth token maintained by the platform.
Authentication
/sessions/refreshRefresh an existing token to keep sessions uninterrupted.
Customers
/customersList customers with filters and summary details.
Jobs
/jobsCreate a new job/work order with scheduling and assignment.
Invoices
/jobs/{jobId}/invoicesCreate an invoice against a job with line items, taxes, and optional delivery.
Payments
/invoices/{invoiceId}/paymentsRecord a payment for an invoice (card, cash, check, ACH).
Use Cases
Customer and Job Data Sync
- Mirror customers, service locations, and jobs into your internal systems - Keep addresses, contact info, and tags current for analytics and routing - Normalize job statuses and timestamps for multi-tenant operations
Scheduling & Dispatch Automation
- Create jobs automatically from lead capture or IoT alerts - Assign technicians based on skills, location, and availability - Update arrival windows and send customer notifications programmatically
Estimates, Invoices & Payments
- Generate quotes from your pricebook, apply taxes/discounts, and convert to invoices - Push invoices and payments to accounting (e.g., QuickBooks) for reconciliation - Record card/ACH/cash/check payments and manage refunds or deposits
Service Plans & Pricebook Management
- Sync memberships, benefits, and recurring visit schedules - Manage pricebook items, bundles, and market-specific pricing - Apply member-only discounts and upsells consistently
Technical Specifications
Authentication
Username/password with MFA/2FA and SSO/OAuth where enabled; supports service accounts or customer-managed credentials
Response format
JSON with consistent resource schemas and pagination across modules
Rate limits
Tuned for enterprise throughput while honoring customer entitlements and usage controls
Session management
Automatic reauth and cookie/session rotation with health checks
Data freshness
Near real-time retrieval of customers, jobs, invoices, and payments
Security
Encrypted transport, scoped tokens, and audit logging; respects Housecall Pro role-based permissions
Webhooks
Optional asynchronous delivery for long-running workflows (e.g., job status changes, invoice payments)
Latency
Sub-second responses for list/detail queries under normal load
Throughput
Designed for high-volume customer/job sync and billing operations
Reliability
Retry logic, backoff, and idempotency keys minimize duplicate actions
Adaptation
Continuous monitoring for UI/API changes with rapid adapter updates
Frequently asked questions
Supergood supports workflows across commonly used modules such as Scheduling & Dispatch, CRM/Customers, Estimates & Invoices, Payments, Pricebook, and Memberships/Service Plans—subject to your licensing and entitlements. We scope coverage during integration assessment.
We support username/password + MFA/2FA and can operate behind SSO/OAuth when enabled. Sessions are refreshed automatically with secure challenge handling.
Yes. We can normalize invoices and payments to match your ERP schema (e.g., QuickBooks line items, taxes, discounts) and deliver updates via webhooks or polling while complying with rate and permission constraints.
Yes. We support downloading artifacts and uploading attachments via signed uploads, with checksum validation and time-limited URLs.