Housecall Pro

Field service management software for scheduling jobs, dispatching crews, and invoicing customers.

6 triggers15 searches21 actionsPollingAuth: API key

AI-assisted documentation24 min read

This documentation is compiled from our integration source code, internal specs for Housecall Pro, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Housecall Pro on WEXTL →

Requirements

To use Housecall Pro on WEXTL you need an active account and an API access token from your account settings.[3]

Get your Housecall Pro credentials

API KeytextRequired
Make sure the token has access to Jobs at least.. Learn more about how to create a API Keys here.
[1]

Connect Housecall Pro in WEXTL

Log in to your WEXTL account, add the Housecall Pro node module to your workflow, and click Create new credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Housecall Pro account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Connecting Housecall Pro to WEXTL® — Video slide demonstrates how to integrate Housecall Pro in the WEXTL visual workflow builder.[4]

Video slide demonstrates how to integrate Housecall Pro in the WEXTL visual workflow builder.[4]

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Housecall Pro node modules

The list below is a reference of every Housecall Pro node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Open any Housecall Pro node module below to inspect its input parameters, outputs, and connection requirements.

Watch CustomersTrigger

Output fields[3]

Field	Type
First Name	text
Last Name	text
Email	email
Company	text
Notifications Enabled	boolean
Mobile Number	text
Home Number	text
Work Number	text
Tags	array
Lead Source	text
Addresses	array

Watch EstimatesTrigger

Output fields[3]

Field	Type
ID	text
Estimate Number	text
Work Status	text
Lead Source	text
Customer	object
First Name	text
Last Name	text
Email	text
Company	text
Notifications Enabled	boolean
Mobile Number	text
Home Number	text
Work Number	text
Tags	array
Lead Source	text
Address	object
ID	text
Street	text
Street Line 2	text
City	text
State	text
Zip	text
Country	text
Work Timestamps	object
Started At	text
Completed At	text
On My Way At	text
Schedule	object
Scheduled Start	text
Scheduled End	text
Arrival Window	text
Assigned Employees	array
Options	array
Created At	date
Updated At	date

Watch LeadsTrigger

Output fields[3]

Field	Type
ID	text
Number	number
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Company	text
Notifications Enabled	boolean
Mobile Number	text
Home Number	text
Work Number	text
Tags	array
Address	object
City	text
State	text
Street	text
Street Line 2	text
Zip	text
Lead Source	text
Line Items	array
Tags	array
Assigned Employee	object
ID	text
First Name	text
Last Name	text
Email	text
Mobile Number	text
Color Hex	text
Avatar Url	text
Role	text
Tags	array
Permissions	object
Status	text
Company Name	text
Company ID	text

Watch New JobsTrigger

Output fields[3]

Field	Type
ID	text
Invoice Number	text
Description	text
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Mobile Number	text
Home Number	text
Work Number	text
Company	text
Notifications Enabled	boolean
Lead Source	text
Address	object
ID	text
Type	text
Street	text
Street Line 2	text
City	text
State	text
Zip	text
Country	text
Notes	array
Work Status	text
Work Timestamps	object
On My Way At	date
Started At	date
Completed At	date
Schedule	object
Scheduled Start	text
Scheduled End	text
Arrival Window	number
Appointments	array
Total Amount	number
Outstanding Balance	number
Assigned Employees	array
Tags	array
Original Estimate ID	text
Original Estimate Uuids	array
Lead Source	text
Job Fields	object
Job Type	object
Business Unit	object
Created At	date
Updated At	date
Company Name	text

2other output fields

Watch Updated EstimatesTrigger

Output fields[3]

Field	Type
ID	text
Estimate Number	text
Work Status	text
Lead Source	text
Customer	object
First Name	text
Last Name	text
Email	text
Company	text
Notifications Enabled	boolean
Mobile Number	text
Home Number	text
Work Number	text
Tags	array
Lead Source	text
Address	object
ID	text
Street	text
Street Line 2	text
City	text
State	text
Zip	text
Country	text
Work Timestamps	object
Started At	text
Completed At	text
On My Way At	text
Schedule	object
Scheduled Start	text
Scheduled End	text
Arrival Window	text
Assigned Employees	array
Options	array
Created At	date
Updated At	date

Watch Updated JobsTrigger

Output fields[3]

Field	Type
ID	text
Invoice Number	text
Description	text
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Mobile Number	text
Home Number	text
Work Number	text
Company	text
Notifications Enabled	boolean
Lead Source	text
Address	object
ID	text
Type	text
Street	text
Street Line 2	text
City	text
State	text
Zip	text
Country	text
Notes	array
Work Status	text
Work Timestamps	object
On My Way At	date
Started At	date
Completed At	date
Schedule	object
Scheduled Start	text
Scheduled End	text
Arrival Window	number
Appointments	array
Total Amount	number
Outstanding Balance	number
Assigned Employees	array
Tags	array
Original Estimate ID	text
Original Estimate Uuids	array
Lead Source	text
Job Fields	object
Job Type	object
Business Unit	object
Created At	date
Updated At	date
Company Name	text

2other output fields

Get a CustomerAction

Input fields[3]

Field	Type
Customer IDRequired	text
Additional Fields	choice

Output fields[3]

Field	Type
ID	text
First Name	text
Last Name	text
Email	text
Mobile Number	text
Home Number	text
Work Number	text
Company	text
Notifications Enabled	boolean
Lead Source	text
Notes	text
Created At	text
Updated At	text
Company Name	text
Company ID	text
Tags	array
Addresses	array
Attachments	array

Get a Customer AddressAction

Input fields[3]

Field	Type
Address IDRequired	text
Customer IDRequired	text

Output fields[3]

Field	Type
ID	text
Invoice number	text
Description	text
Customer	object
ID	text
First name	text
Last name	text
Email	text
Mobile number	text
Home number	text
Work number	text
Company	text
Notifications enabled	boolean
Lead source	text
Address	object
ID	text
Type	text
Street	text
Street line 2	text
City	text
State	text
Zip	text
Country	text
Notes	array
Work status	text
Work timestamps	object
On my way at	text
Started at	text
Completed at	text
Schedule	object
Scheduled start	text
Scheduled end	text
Arrival window	number
Appointments	array
Total amount	number
Outstanding balance	number
Assigned employees	array
Tags	array
Original estimate ID	text
Lead source	text
Job fields	object
Job type	object
Business unit	object
Attachments	array
Created at	date
Updated at	date
Company name	text

1other output field

Get a JobAction

Input fields[3]

Field	Type
Job IDRequired	text
Expand	choice

Output fields[3]

Field	Type
ID	text
Invoice number	text
Description	text
Customer	object
ID	text
First name	text
Last name	text
Email	text
Mobile number	text
Home number	text
Work number	text
Company	text
Notifications enabled	boolean
Lead source	text
Address	object
ID	text
Type	text
Street	text
Street line 2	text
City	text
State	text
Zip	text
Country	text
Notes	array
Work status	text
Work timestamps	object
On my way at	text
Started at	text
Completed at	text
Schedule	object
Scheduled start	text
Scheduled end	text
Arrival window	number
Appointments	array
Total amount	number
Outstanding balance	number
Assigned employees	array
Tags	array
Original estimate ID	text
Lead source	text
Job fields	object
Job type	object
Business unit	object
Attachments	array
Created at	date
Updated at	date
Company name	text

1other output field

Get a LeadAction

Input fields[3]

Field	Type
Customer IDRequired	text
Additional Fields	choice

Output fields[3]

Field	Type
ID	text
Number	number
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Company	text
Notifications Enabled	boolean
Mobile Number	text
Home Number	text
Work Number	text
Tags	array
Address	object
City	text
State	text
Street	text
Street Line 2	text
Zip	text
Lead Source	text
Line Items	array
Tags	array
Assigned Employee	object
ID	text
First Name	text
Last Name	text
Email	text
Mobile Number	text
Color Hex	text
Avatar Url	text
Role	text
Tags	array
Permissions	object
Status	text
Company Name	text
Company ID	text

Get an EstimateAction

Input fields[3]

Field	Type
Estimate IDRequired	text
Additional Fields	choice

Output fields[3]

Field	Type
ID	text
Estimate Number	text
Work Status	text
Lead Source	text
Customer	object
First Name	text
Last Name	text
Email	text
Company	text
Notifications Enabled	boolean
Mobile Number	text
Home Number	text
Work Number	text
Tags	array
Lead Source	text
Address	object
ID	text
Street	text
Street Line 2	text
City	text
State	text
Zip	text
Country	text
Work Timestamps	object
Started At	text
Completed At	text
On My Way At	text
Schedule	object
Scheduled Start	text
Scheduled End	text
Arrival Window	text
Assigned Employees	array
Options	array
Created At	date
Updated At	date

List Customer AddressesSearch

Input fields[3]

Field	Type
Customer IDRequired	text
Sort By	choice
Sort Direction	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Type	text
Street	text
Street line 2	text
City	text
State	text
Zip	text
Country	text

List EmployeesSearch

Input fields[3]

Field	Type
Location IDs	array
Sort By	text
Sort Direction	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Avatar URL	url
Color hex	text
First name	text
Last name	text
Email	text
Mobile number	text
Role	text
Tags	array
Permissions	object
Can add and edit job	boolean
Can be booked online	boolean
Can call and text with customers	boolean
Can chat with customers	boolean
Can delete and cancel job	boolean
Can edit message on invoice	boolean
Can see street view data	boolean
Can share job	boolean
Can take payment see prices	boolean
Can see customers	boolean

List Job AppointmentsSearch

Input fields[3]

Field	Type
Job IDRequired	text
Limit	number

Output fields[3]

Field	Type
ID	text
Start time	text
End time	text
Arrival window minutes	number
Dispatched employees ids	array

List Job InvoicesSearch

Input fields[3]

Field	Type
Job IDRequired	text
Limit	number

Output fields[3]

Field	Type
ID	text
Status	text
Invoice Number	text
Amount	number
Due Amount	number
Due t	date
Display Due Concept	text
Due Concept	text
Paid at	date
Sent at	date
Service Date	text
Invoice Date	text
Items	array
Taxes	array
Discounts	array
Payments	array

List Schedule WindowsSearch

Output fields[3]

Field	Type
Availability buffer in days	number
Daily availabilities	object
Data	array

Search ChecklistsSearch

Input fields[3]

Field	Type
Estimate UUIDsRequired	array
Job UUIDsRequired	array
Limit	number

Output fields[3]

Field	Type
ID	text
Title	text
Job UUID	text
Estimate UUID	text
Sections	array

Search CustomersSearch

Input fields[3]

Field	Type
Query	text
Sort By	choice
Sort Direction	choice
Additional Fields	choice
Location IDs	array
Limit	number

Output fields[3]

Field	Type
ID	text
First Name	text
Last Name	text
Email	text
Mobile Number	text
Home Number	text
Work Number	text
Company	text
Notifications Enabled	boolean
Lead Source	text
Notes	text
Created At	text
Updated At	text
Company Name	text
Company ID	text
Tags	array
Addresses	array
Attachments	array

Search EstimatesSearch

Input fields[3]

Field	Type
Customer ID	text
Employee IDs	array
Expand	choice
Location IDs	array
Scheduled End Max	text
Scheduled End Min	text
Scheduled Start Max	text
Scheduled Start Min	text
Sort By	choice
Sort Direction	choice
Work Status	array
Limit	number

Output fields[3]

Field	Type
ID	text
Estimate number	text
Work status	text
Lead source	text
Customer	object
ID	text
First name	text
Last name	text
Email	text
Mobile number	text
Home number	text
Work number	text
Company	text
Notifications enabled	boolean
Lead source	text
Address	object
ID	text
Type	text
Street	text
Street line 2	text
City	text
State	text
Zip	text
Country	text
Created at	text
Updated at	text
Company name	text
Company ID	text
Work timestamps	object
On my way at	text
Started at	text
Completed at	text
Schedule	object
Scheduled start	text
Scheduled end	text
Arrival window	number
Appointments	array
Assigned employees	array
Estimate fields	object
Job type ID	text
Business unit ID	text
Options	array

Search JobsSearch

Input fields[3]

Field	Type
Customer ID	text
Employee IDs	array
Expand	choice
Franchisee IDs	array
Location IDs	array
Scheduled End Max	text
Scheduled End Min	text
Scheduled Start Max	text
Scheduled Start Min	text
Sort By	choice
Sort Direction	choice
Work Status	array
Limit	number

Output fields[3]

Field	Type
ID	text
Invoice number	text
Description	text
Customer	object
ID	text
First name	text
Last name	text
Email	text
Mobile number	text
Home number	text
Work number	text
Company	text
Notifications enabled	boolean
Lead source	text
Address	object
ID	text
Type	text
Street	text
Street line 2	text
City	text
State	text
Zip	text
Country	text
Notes	array
Work status	text
Work timestamps	object
On my way at	text
Started at	text
Completed at	text
Schedule	object
Scheduled start	text
Scheduled end	text
Arrival window	number
Appointments	array
Total amount	number
Outstanding balance	number
Assigned employees	array
Tags	array
Original estimate ID	text
Lead source	text
Job fields	object
Job type	object
Business unit	object
Attachments	array
Created at	date
Updated at	date
Company name	text

1other output field

Search LeadsSearch

Input fields[3]

Field	Type
Customer ID	text
Employee IDs	array
Employee ID	text
Lead Source	array
Lead Source	text
Location IDs	array
Location ID	text
Status	choice
Tag IDs	array
Tag ID	text
Sort By	choice
Sort Direction	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Number	number
Customer	object
ID	text
First name	text
Last name	text
Email	text
Company	text
Notifications enabled	boolean
Mobile number	text
Home number	text
Work number	text
Tags	array
Address	object
City	text
State	text
Street	text
Street line 2	text
Zip	text
Lead source	text
Line items	array
Tags	array
Assigned employee	object
ID	text
First name	text
Last name	text
Email	text
Mobile number	text
Color hex	text
Avatar URL	text
Role	text
Tags	array
Permissions	object
Status	text
Company name	text
Company ID	text

Add a Job Line ItemAction

Input fields[3]

Field	Type
Job IDRequired	text
NameRequired	text
Description	text
Unit Price	number
Quantity	number
Unit Cost	number
Kind	choice
Taxable	boolean
Service Item ID	text
Service Item Type	choice

Output fields[3]

Field	Type
ID	text
Name	text
Description	text
Unit price	number
Unit cost	number
Unit of measure	number
Quantity	number
Kind	text
Taxable	boolean
Amount	number
Order index	number
Service item ID	text
Service item type	text

Add a Job NoteAction

Input fields[3]

Field	Type
Job IDRequired	text
Content	text

Output fields[3]

Field	Type
ID	text
Content	text

Add a Job TagAction

Input fields[3]

Field	Type
Job IDRequired	text
Tag IDRequired	choice

Output fields[3]

Field	Type
Tags	array

Add an Attachment to a JobAction

Input fields[3]

Field	Type
Job IDRequired	text
File NameRequired	text
DataRequired	text

Output fields[3]

Field	Type
Job URL	url

Add an Estimate AttachmentAction

Input fields[3]

Field	Type
Estimate IDRequired	text
Option IDRequired	text
FileRequired	text

Output fields[3]

Field	Type
Estimate URL	text

Create a CustomerAction

Input fields[3]

Field	Type
First Name	text
Last Name	text
Email	email
Company	text
Notifications Enabled	boolean
Mobile Number	text
Home Number	text
Work Number	text
Tags	array
Lead Source	choice
Notes	text
Addresses	array

Output fields[3]

Field	Type
ID	text
First Name	text
Last Name	text
Email	text
Mobile Number	text
Home Number	text
Work Number	text
Company	text
Notifications Enabled	boolean
Lead Source	text
Notes	text
Created At	text
Updated At	text
Company Name	text
Company ID	text
Tags	array
Addresses	array
Attachments	array

Create a Customer AddressAction

Input fields[3]

Field	Type
Customer IDRequired	text
StreetRequired	text
Street Line 2	text
CityRequired	text
StateRequired	text
ZipRequired	text
CountryRequired	text
Latitude	number
Longitude	number

Output fields[3]

Field	Type
ID	text
Type	text
Street	text
Street line 2	text
City	text
State	text
Zip	text
Country	text

Create a JobAction

Input fields[3]

Field	Type
Customer IDRequired	text
Address IDRequired	text
Invoice Number	number
Schedule	object
Scheduled Start	text
Scheduled End	text
Arrival Window	number
Assigned Employee IDs	array
Line Items	array
Pricing Form	text
Tags	array
Lead Source	text
Notes	text
Job Fields	object
Job Type ID	text
Business Unit ID	text

Output fields[3]

Field	Type
ID	text
Invoice number	text
Description	text
Customer	object
ID	text
First name	text
Last name	text
Email	text
Mobile number	text
Home number	text
Work number	text
Company	text
Notifications enabled	boolean
Lead source	text
Address	object
ID	text
Type	text
Street	text
Street line 2	text
City	text
State	text
Zip	text
Country	text
Notes	array
Work status	text
Work timestamps	object
On my way at	text
Started at	text
Completed at	text
Schedule	object
Scheduled start	text
Scheduled end	text
Arrival window	number
Appointments	array
Total amount	number
Outstanding balance	number
Assigned employees	array
Tags	array
Original estimate ID	text
Lead source	text
Job fields	object
Job type	object
Business unit	object
Attachments	array
Created at	date
Updated at	date
Company name	text

1other output field

Create a Job AppointmentAction

Input fields[3]

Field	Type
Job IDRequired	text
Start TimeRequired	date
End TimeRequired	date
Dispatched Employees IDsRequired	array
Employee ID	text
Arrival Window Minutes	number

Output fields[3]

Field	Type
ID	text
Start time	text
End time	text
Arrival window minutes	number
Dispatched employees ids	array

Create a Job LinkAction

Input fields[3]

Field	Type
Job IDRequired	text
TitleRequired	text
URLRequired	url

Output fields[3]

Field	Type
ID	text
Title	text
URL	url

Create a LeadAction

Input fields[3]

Field	Type
Customer ID	text
Customer	object
First Name	text
Last Name	text
Email	email
Notifications Enabled	boolean
Mobile Number	text
Company	text
Home Number	text
Work Number	text
Lead Source	text
Notes	text
Addresses	array
Assigned Employee ID	text
Line Items	array

Output fields[3]

Field	Type
ID	text
Number	number
Customer	object
ID	text
First name	text
Last name	text
Email	text
Company	text
Notifications enabled	boolean
Mobile number	text
Home number	text
Work number	text
Tags	array
Address	object
City	text
State	text
Street	text
Street line 2	text
Zip	text
Lead source	text
Line items	array
Tags	array
Assigned employee	object
ID	text
First name	text
Last name	text
Email	text
Mobile number	text
Color hex	text
Avatar URL	text
Role	text
Tags	array
Permissions	object
Status	text
Company name	text
Company ID	text

Create an EstimateAction

Input fields[3]

Field	Type
Estimate Number	number
Note	text
Message	text
Customer ID	text
Assigned Employee IDs	array
Address ID	text
Lead Source	text
Address	object
Street	text
Street Line 2	text
City	text
State	text
Zip	text
Options	array
Tags	array
Line Items	array
Tax	object
Taxable	boolean
Tax Rate	number
Tax Name	text
Schedule	object
Start Time	text
End Time	text
Arrival Window in Minutes	number
Notify Customer	boolean
Estimate Fields	object
Job Type ID	text
Business Unit ID	text

Output fields[3]

Field	Type
ID	text
Estimate number	text
Work status	text
Lead source	text
Customer	object
ID	text
First name	text
Last name	text
Email	text
Mobile number	text
Home number	text
Work number	text
Company	text
Notifications enabled	boolean
Lead source	text
Address	object
ID	text
Type	text
Street	text
Street line 2	text
City	text
State	text
Zip	text
Country	text
Created at	text
Updated at	text
Company name	text
Company ID	text
Work timestamps	object
On my way at	text
Started at	text
Completed at	text
Schedule	object
Scheduled start	text
Scheduled end	text
Arrival window	number
Appointments	array
Assigned employees	array
Estimate fields	object
Job type ID	text
Business unit ID	text
Options	array

Create an Estimate Option LinkAction

Input fields[3]

Field	Type
Estimate IDRequired	text
Option IDRequired	text
TitleRequired	text
URLRequired	url

Output fields[3]

Field	Type
ID	text
Title	text
URL	url

Create an Estimate Option NoteAction

Input fields[3]

Field	Type
Estimate IDRequired	text
Option IDRequired	text
Content	text

Output fields[3]

Field	Type
ID	text
Content	text

Delete a Job AppointmentAction

Input fields[3]

Field	Type
Job IDRequired	text
Appointment IDRequired	text

Output fields[3]

Field	Type
ID	text
Start time	text
End time	text
Arrival window minutes	number
Dispatched employees ids	array

Delete a Job NoteAction

Input fields[3]

Field	Type
Job IDRequired	text
Note IDRequired	text

Delete a Job TagAction

Input fields[3]

Field	Type
Job IDRequired	text
Tag IDRequired	choice

Delete an Estimate Option NoteAction

Input fields[3]

Field	Type
Estimate IDRequired	text
Option IDRequired	text
Note IDRequired	text

Output fields[3]

Field	Type
ID	text
Content	text

Make an API Calluniversal

Input fields[3]

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Key	text
Value	text
Query String	array
Key	text
Value	text
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Update a CustomerAction

Input fields[3]

Field	Type
Customer IDRequired	text
First Name	text
Last Name	text
Email	email
Company	text
Notifications Enabled	boolean
Mobile Number	text
Home Number	text
Work Number	text
Tags	array
Lead Source	choice
Note	text

Output fields[3]

Field	Type
ID	text
First Name	text
Last Name	text
Email	text
Mobile Number	text
Home Number	text
Work Number	text
Company	text
Notifications Enabled	boolean
Lead Source	text
Notes	text
Created At	text
Updated At	text
Company Name	text
Company ID	text
Tags	array
Addresses	array
Attachments	array

Update a Job AppointmentAction

Input fields[3]

Field	Type
Job IDRequired	text
Appointment IDRequired	text
Start TimeRequired	date
End TimeRequired	date
Dispatched Employees IDsRequired	array
Employee ID	text
Arrival Window Minutes	number

Output fields[3]

Field	Type
ID	text
Start time	text
End time	text
Arrival window minutes	number
Dispatched employees ids	array

Templates

Look for Housecall Pro templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Project Management category →

References

WEXTL® Housecall Pro Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Housecall Pro.
WEXTL® visual workflow builder data.

Last updated: Jul 24, 2026 18:11

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.