The Housecall Pro connector lets your AI agent act in each user's Housecall Pro account. Each user connects their own Housecall Pro API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 28 · 27 · 528 read27 write5 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Housecall Pro connection
In AgentKit > Connections, create a Housecall Pro connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'housecallpro'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Housecall Pro:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'housecallpro_company_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "housecallpro"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Housecall Pro:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="housecallpro_company_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Housecall Pro credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolhousecallpro_company_getGet the company profile.Read-onlyGet Company
Get the company profile. Returns name, phone, email, address, time zone, logo and support contact. Use this for company details.
Inputs
This tool takes no inputs.
housecallpro_customer_address_getGet one of a customer's addresses.Read-onlyGet Customer Address
Get one of a customer's addresses. Returns the address. Use this when you know both IDs.
Inputs
address_idstringrequired- address id. Example: adr_1f2e3d4c5b6a4987a6b5c4d3e2f1a0b9.
customer_idstringrequired- customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
housecallpro_customer_addresses_listList a customer's service and billing addresses.Read-onlyList Customer Addresses
List a customer's service and billing addresses. Returns addresses with id, type, street, city, state, zip. Use this to pick an address_id for a job.
Inputs
customer_idstringrequired- customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
pagenumber- Paginated page number. Example: 1.
page_sizenumber- Number of addresses returned per page. Example: 25.
sort_bystring- Address attribute to sort by. One of: created_at, updated_at. Defaults to created_at. Example: created_at.one of
created_atupdated_at sort_directionstring- Ascending or descending. One of: desc, asc. Defaults to desc. Example: desc.one of
descasc
housecallpro_customer_getGet one customer.Read-onlyGet Customer
Get one customer. Returns the customer with contact details, tags, lead source, notes and addresses. Use this when you know the ID.
Inputs
customer_idstringrequired- customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
expandarray- Array of strings to expand response body. Example: ["attachments"]
housecallpro_customers_listList customers, optionally searched by name, email, phone or address.Read-onlyList Customers
List customers, optionally searched by name, email, phone or address. Returns a page of customers (id, first_name, last_name, email, mobile_number, company, tags, addresses) plus page, page_size, total_pages and total_items. Use this to find a customer. Use housecallpro_customer_get for one.
Inputs
expandarray- Array of strings to expand response body. Example: ["attachments"]
location_idsarray- Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
pagenumber- Current Page. Defaults to 1. Example: 1.
page_sizenumber- Number of customers per page. Defaults to 10. Example: 25.
qstring- A query that can be used to search for a customer by name, email, mobile number and address. Example: Smith.
sort_bystring- Customer attribute to sort by. Defaults to created_at. Example: created_at.
sort_directionstring- Ascending or descending. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc
housecallpro_employees_listList employees (pros).Read-onlyList Employees
List employees (pros). Returns a page of employees (id, first_name, last_name, email, mobile_number, role, color_hex) plus page, page_size, total_pages and total_items. Use this for employee IDs to assign or dispatch.
Inputs
location_idsarray- Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
pagenumber- Current page. Defaults to 1. Example: 1.
page_sizenumber- Number of employees per page. Defaults to 10. Example: 25.
sort_bystring- employee attribute to sort_by. Defaults to created_at. Example: created_at.
sort_directionstring- Ascending or descending. Defaults to desc. Example: desc.
housecallpro_estimate_getGet one estimate.Read-onlyGet Estimate
Get one estimate. Returns the estimate with customer, address, schedule and options (with status and total). Use this when you know the ID.
Inputs
estimate_idstringrequired- estimate id. Example: est_9a8b7c6d5e4f4a3b2c1d0e9f8a7b6c5d.
expandarray- Array of strings to expand response body. Example: ["attachments"]
housecallpro_estimate_option_line_items_listList the line items of an estimate option.Read-onlyList Estimate Option Line Items
List the line items of an estimate option. Returns line items with name, unit_price, quantity and amount. Use this to review an option.
Inputs
estimate_idstringrequired- estimate id. Example: est_9a8b7c6d5e4f4a3b2c1d0e9f8a7b6c5d.
option_idstringrequired- option id. Example: opt_2c3d4e5f6a7b4c8d9e0f1a2b3c4d5e6f.
pagestring- Paginated page number. Defaults to 1. Example: 1.
page_sizenumber- Number of line items returned per page. Defaults to 10. Example: 25.
housecallpro_estimates_listList estimates, filterable by customer, employees, work status and schedule range.Read-onlyList Estimates
List estimates, filterable by customer, employees, work status and schedule range. Returns a page of estimates (id, estimate_number, customer, address, work_status, options with totals) plus page, page_size, total_pages and total_items. Use this to find estimates. Use housecallpro_estimate_get for one.
Inputs
customer_idstring- Filters estimates by a single customer ID (string). Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
employee_idsarray- Filters estimates by assigned pro id. Example: ["pro_5c6d7e8f9a0b"]
expandarray- Array of strings to expand response body. Example: ["attachments"]
location_idsarray- Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
pagestring- Paginated page number. Defaults to 1. Example: 1.
page_sizenumber- Number of estimates returned per page. Defaults to 10. Example: 25.
scheduled_end_maxstring- Filters estimates with an end time less than or equal to the date sent. Example: 2026-01-31T23:59:59Z.
scheduled_end_minstring- Filters estimates with an end time greater than or equal to the date sent. Example: 2026-01-01T00:00:00Z.
scheduled_start_maxstring- Filters estimates with a starting time less than or equal to the date sent. Example: 2026-01-31T23:59:59Z.
scheduled_start_minstring- Filters estimates with a starting time greater than or equal to the date sent. Example: 2026-01-01T00:00:00Z.
sort_bystring- Attribute to sort by. One of: created_at, updated_at, id. Defaults to created_at. Example: created_at.one of
created_atupdated_atid sort_directionstring- Order of estimates returned. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc work_statusarray- Work status filter. Returns estimates from all statuses if empty. Example: ["scheduled"]
housecallpro_event_getGet one event.Read-onlyGet Event
Get one event. Returns the event with name, schedule and employees. Use this when you know the ID.
Inputs
event_idstringrequired- event id. Example: evt_6f5e4d3c2b1a4f0e9d8c7b6a5f4e3d2c.
housecallpro_events_listList company events (calendar events that are not jobs, e.g.Read-onlyList Events
List company events (calendar events that are not jobs, e.g. meetings or time off). Returns a page of events (id, name, schedule, assigned employees) plus page, page_size, total_pages and total_items. Use housecallpro_event_get for one.
Inputs
location_idsarray- Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
pagenumber- Paginated page number. Example: 1.
page_sizenumber- Number of events returned per page. Example: 25.
sort_bystring- Event attribute to sort by. One of: name, note, created_at, updated_at, street, street_line_2, city, state, zip. Defaults to created_at. Example: created_at.one of
namenotecreated_atupdated_atstreetstreet_line_2citystatezip sort_directionstring- Ascending or descending. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc
housecallpro_invoice_getGet one invoice by UUID.Read-onlyGet Invoice
Get one invoice by UUID. Returns the invoice with line items, taxes, discounts, payments and balances. Use this when you know the invoice UUID.
Inputs
uuidstringrequired- The UUID of the invoice to retrieve. Example: inv_7e6d5c4b3a2f4e1d0c9b8a7f6e5d4c3b.
housecallpro_invoices_listList invoices, filterable by status, customer and dates.Read-onlyList Invoices
List invoices, filterable by status, customer and dates. Returns a page of invoices (id, invoice_number, job_id, status, amount, due_amount, due_at, paid_at) plus page, page_size, total_pages and total_items. Use housecallpro_invoice_get for one.
Inputs
amount_due_maxnumber- Filters invoices with an amount_due less than or equal to the input amount. Example: 10.
amount_due_minnumber- Filters invoices with an amount_due greater than or equal to the input amount. Example: 10.
created_at_maxstring- Filters invoices with a created_at less than or equal to the input date. Example: 2024-01-30T00:00:00Z.
created_at_minstring- Filters invoices with a created_at greater than or equal to the input date. Example: 2024-01-30T00:00:00Z.
customer_uuidarray- Filters invoices by customer UUIDs. Example: cus_123.
due_at_maxstring- Filters invoices with a due_at less than or equal to the input date. Example: 2024-01-30T00:00:00Z.
due_at_minstring- Filters invoices with a due_at greater than or equal to the input date. Example: 2024-01-30T00:00:00Z.
location_idsarray- Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
pageinteger- Paginated page number. Defaults to 1. Example: 1.
page_sizestring- Number of invoices returned per page. Defaults to 10. Example: 25.
paid_at_maxstring- Filters invoices with a paid_at less than or equal to the input date. Example: 2024-01-30T00:00:00Z.
paid_at_minstring- Filters invoices with a paid_at greater than or equal to the input date. Example: 2024-01-30T00:00:00Z.
payment_methodarray- Filters invoices by payment_method. Example: credit_card.
sort_bystring- sort by. One of: amount, created_at, due_amount, due_at, invoice_number, paid_at, sent_at, status, updated_at. Defaults to created_at. Example: created_at.one of
amountcreated_atdue_amountdue_atinvoice_numberpaid_atsent_atstatusupdated_at sort_directionstring- sort direction. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc statusarray- Filters invoices by status. Example: open.
housecallpro_job_appointments_listList the appointments (visits) of a multi-visit job.Read-onlyList Job Appointments
List the appointments (visits) of a multi-visit job. Returns appointments with id, start_time, end_time, arrival window and dispatched employees. Use this to see a job's visits.
Inputs
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
housecallpro_job_getGet one job.Read-onlyGet Job
Get one job. Returns the job with customer, address, schedule, work status, line items summary, totals, tags and assigned employees. Use this when you know the job ID.
Inputs
idstringrequired- The ID of the job. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
expandarray- Array of strings to expand response body. Example: ["attachments"]
housecallpro_job_invoices_listList the invoices of a job.Read-onlyList Job Invoices
List the invoices of a job. Returns invoices with id, invoice_number, status, amount, due_amount and dates. Use this to check what was billed for a job.
Inputs
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
housecallpro_job_line_items_listList a job's line items.Read-onlyList Job Line Items
List a job's line items. Returns line items with id, name, description, unit_price, quantity, kind and amount. Use this before updating or deleting a line item.
Inputs
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
housecallpro_job_types_listList job types.Read-onlyList Job Types
List job types. Returns a page of job types (id, name) plus page, page_size, total_pages and total_items. Use this for job_fields.job_type_id.
Inputs
namestring- filter job types by name. Example: sk-test item.
housecallpro_jobs_listList jobs, filtered by customer, assigned employees, work status or scheduled start/end range.Read-onlyList Jobs
List jobs, filtered by customer, assigned employees, work status or scheduled start/end range. Returns a page of jobs (id, invoice_number, description, customer, address, work_status, schedule, total_amount, outstanding_balance, assigned_employees) plus page, page_size, total_pages and total_items. Use this to find jobs. Use housecallpro_job_get for one.
Inputs
customer_idstring- Filters jobs by a single customer ID (string). Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
employee_idsarray- employee ids. Example: ["pro_5c6d7e8f9a0b"]
expandarray- Array of strings to expand response body. Example: ["attachments"]
location_idsarray- Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
pagestring- Paginated page number. Defaults to 1. Example: 1.
page_sizenumber- Number of jobs returned per page. Defaults to 10. Example: 25.
scheduled_end_maxstring- Filters jobs with an end time less than or equal to the date sent. Example: 2026-01-31T23:59:59Z.
scheduled_end_minstring- Filters jobs with an end time greater than or equal to the date sent. Example: 2026-01-01T00:00:00Z.
scheduled_start_maxstring- Filters jobs with a starting time less than or equal to the date sent. Example: 2026-01-31T23:59:59Z.
scheduled_start_minstring- Filters jobs with a starting time greater than or equal to the date sent. Example: 2026-01-01T00:00:00Z.
sort_bystring- Attribute to sort by. One of: created_at, updated_at, invoice_number, id, description, work_status. Defaults to created_at. Example: created_at.one of
created_atupdated_atinvoice_numberiddescriptionwork_status sort_directionstring- sort direction. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc work_statusarray- Work status filter. Returns jobs from all statuses if empty. Example: ["scheduled"]
housecallpro_lead_getGet one lead.Read-onlyGet Lead
Get one lead. Returns the lead with customer, address, line items, notes and status. Use this when you know the ID.
Inputs
idstringrequired- id. Example: lead_3c4d5e6f7a8b4c9d0e1f2a3b4c5d6e7f.
housecallpro_lead_sources_listList lead sources.Read-onlyList Lead Sources
List lead sources. Returns a page of lead sources (id, name) plus page, page_size, total_pages and total_items. Use this for lead_source values.
Inputs
pagenumber- Current Page. Defaults to 1. Example: 1.
page_sizenumber- Number of lead sources per page. Defaults to 10. Example: 25.
qstring- A query that can be used to search for a lead source by name. Example: Smith.
sort_directionstring- Ascending or descending. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc
housecallpro_leads_listList leads.Read-onlyList Leads
List leads. Returns a page of leads (id, number, customer, address, status, lead_source, assigned employee) plus page, page_size, total_pages and total_items. Use this to find leads. Use housecallpro_lead_get for one.
Inputs
customer_idstring- Filters leads by a single customer ID (string). Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
employee_idsarray- Filters leads by a list of employee IDs (string). Example: ["pro_5c6d7e8f9a0b"]
lead_sourcearray- Filters leads by a single lead_source. Example: Google.
location_idsarray- Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
pagestring- Paginated page number. Defaults to 1. Example: 1.
page_sizenumber- Number of jobs returned per page. Defaults to 10. Example: 25.
sort_bystring- Attribute to sort by. One of: created_at, updated_at, id, status. Defaults to created_at. Example: created_at.one of
created_atupdated_atidstatus sort_directionstring- sort direction. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc statusstring- Filters leads by status. One of: lost, open, won. Example: lost.one of
lostopenwon tag_idsarray- Filters leads by a list of tags. Example: ["tag_3e4f5a6b7c8d4e9f0a1b2c3d4e5f6a7b"]
housecallpro_materials_listList price book materials in a material category.Read-onlyList Price Book Materials
List price book materials in a material category. Returns materials with uuid, name, price, cost, part_number and unit_of_measure. Use this to find materials to bill.
Inputs
material_category_uuidstringrequired- UUID of the material category to fetch materials under. Example: pbmcat_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6.
pagenumber- Paginated page number. Defaults to 1. Example: 1.
page_sizenumber- Number of materials returned per page. Defaults to 10. Example: 25.
sort_bystring- Material attribute to sort by. One of: name, updated_at, created_at. Defaults to created_at. Example: created_at.one of
nameupdated_atcreated_at sort_directionstring- Ascending or descending. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc
housecallpro_pipeline_statuses_listList sales pipeline statuses for leads, estimates or jobs.Read-onlyList Pipeline Statuses
List sales pipeline statuses for leads, estimates or jobs. Returns statuses with id, name and resource type. Use this before housecallpro_pipeline_status_update.
Inputs
resource_typestringrequired- resource type. One of: lead, job, estimate. Example: job.one of
leadjobestimate pageinteger- page. Defaults to 1. Example: 1.
page_sizeinteger- page size. Defaults to 10. Example: 25.
housecallpro_price_book_services_listList price book services.Read-onlyList Price Book Services
List price book services. Returns services with uuid, name, price, category and duration. Use this to find services to bill.
Inputs
expandarray- Array of strings to expand in the response body. Sent as repeated expand[] query params (e.g. expand[]=service_materials&expand[]=service_labor_rates). By default service_materials and service_labor_rates are returned as empty lists ({ "object": "list", "data": [] }); include the corresponding value here to populate its data array. Supported values: service_materials, service_labor_rates. Example: ["service_materials"]
filter_operatorstring- Filter operator (sent as filters[][operator]); only eq is supported. Example: eq.one of
eq filter_propertystring- Filter on one property (sent as filters[][property]); use with filter_value. Example: online_booking_enabled.one of
online_booking_enabledmanaged_byflat_rate_enabledtaxablecategoryorganization_industry filter_valuestring- Filter value (sent as filters[][values][]), e.g. true or a category name. Example: true.
pagenumber- Current Page. Defaults to 1. Example: 1.
page_sizenumber- Number of items returned per page. Defaults to 10. Example: 25.
qstring- A query that can be used to search for a service by name, description and task_number. Example: Smith.
sort_bystring- Price book service attribute to sort by. Defaults to created_at. Example: created_at.
sort_directionstring- Ascending or descending. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc
housecallpro_schedule_availability_getGet the company's schedule windows (working hours per day used for online booking).Read-onlyGet Schedule Availability
Get the company's schedule windows (working hours per day used for online booking). Returns daily availability windows and settings. Use this to know when jobs can be booked.
Inputs
This tool takes no inputs.
housecallpro_service_zones_listList service zones (areas the company serves).Read-onlyList Service Zones
List service zones (areas the company serves). Returns zones with id, name and postal codes. Use this to check coverage.
Inputs
addressstring- Filter service zones by address. Example: {"street": "123 Main St", "city": "San Francisco", "state": "CA", "zip": "94105"}
pagenumber- Current Page. Defaults to 1. Example: 1.
page_sizenumber- Number of service zones per page. Defaults to 10. Example: 25.
zip_codestring- Filter service zones by zip code. Example: 94105.
housecallpro_customer_address_createAdd an address to a customer.WriteCreate Customer Address
Add an address to a customer. Returns the created address. Use this before creating a job at a new address.
Inputs
citystringrequired- city. Example: San Francisco.
countrystringrequired- country. Example: US.
customer_idstringrequired- customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
statestringrequired- state. Example: CA.
streetstringrequired- street. Example: 500 Market St.
zipstringrequired- zip. Example: 94105.
latitudenumber- latitude. Example: 1.
longitudenumber- longitude. Example: 1.
street_line_2string- street line 2. Example: Suite 2.
housecallpro_customer_createCreate a customer with contact details, tags, lead source and addresses.WriteCreate Customer
Create a customer with contact details, tags, lead source and addresses. Returns the created customer. Use this before creating jobs or estimates for a new customer.
Inputs
addressesarray- addresses. Example: [{"street": "123 Main St", "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US"}]
companystring- company. Example: Doe Plumbing.
emailstring- email. Example: jane.doe@example.com.
first_namestring- first name. Example: Jane.
home_numberstring- home number. Example: 4155550101.
last_namestring- last name. Example: Doe.
lead_sourcestring- lead source. Example: Google.
mobile_numberstring- mobile number. Example: 4155550100.
notesstring- notes. Example: Gate code 1234.
notifications_enabledboolean- Will the customer receive notifications. Example: true.
tagsarray- tags. Example: ["VIP"]
work_numberstring- work number. Example: 4155550102.
housecallpro_customer_updateUpdate a customer's contact details, tags, lead source or notes.WriteUpdate Customer
Update a customer's contact details, tags, lead source or notes. Returns the updated customer. Use housecallpro_customer_address_create to add an address.
- Idempotent
Inputs
customer_idstringrequired- customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
companystring- company. Example: Doe Plumbing.
emailstring- email. Example: jane.doe@example.com.
first_namestring- first name. Example: Jane.
home_numberstring- home number. Example: 4155550101.
last_namestring- last name. Example: Doe.
lead_sourcestring- lead source. Example: Google.
mobile_numberstring- mobile number. Example: 4155550100.
notesstring- notes. Example: Gate code 1234.
notifications_enabledboolean- Will the customer receive notifications. Example: true.
tagsarray- tags. Example: ["VIP"]
work_numberstring- work number. Example: 4155550102.
housecallpro_estimate_createCreate an estimate for an existing customer (customer_id + address_id) or a new one (address), with options and line items.WriteCreate Estimate
Create an estimate for an existing customer (customer_id + address_id) or a new one (address), with options and line items. Returns the created estimate. Use this to send a quote. Use housecallpro_estimate_options_approve when the customer accepts.
Inputs
addressobject- address. Example: {"street": "123 Main St", "city": "San Francisco", "state": "CA", "zip": "94105"}
address_idstring- address id. Example: adr_1f2e3d4c5b6a4987a6b5c4d3e2f1a0b9.
assigned_employee_idsarray- assigned employee ids. Example: ["pro_5c6d7e8f9a0b"]
customer_idstring- customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
estimate_fieldsobject- estimate fields. Example: {"job_type_id": "jt_1b2c3d4e5f6a47b8c9d0e1f2a3b4c5d6"}
estimate_numberinteger- Estimate number unique across all of a company's estimates in Housecall Pro. If left blank, one will be automatically generated. Example: 2001.
lead_sourcestring- lead source. Example: Google.
messagestring- message. Example: Thanks for the opportunity!.
notestring- note. Example: Customer prefers mornings.
optionsarray- options. Example: [{"name": "Option A", "line_items": [{"name": "Install", "unit_price": 50000, "quantity": 1}]}]
scheduleobject- schedule. Example: {"scheduled_start": "2026-01-15T16:00:00Z", "scheduled_end": "2026-01-15T18:00:00Z", "arrival_window": 60}
taxobject- tax. Example: {"name": "Sales tax", "rate": 8.5}
housecallpro_estimate_option_createAdd an option (an alternative quote) with line items to an estimate.WriteCreate Estimate Option
Add an option (an alternative quote) with line items to an estimate. Returns the created option. Use this to offer good/better/best options.
Inputs
estimate_idstringrequired- The UUID of the estimate. Example: est_9a8b7c6d5e4f4a3b2c1d0e9f8a7b6c5d.
namestringrequired- Name of the estimate option. Example: sk-test item.
line_itemsarray- Line items to add to the option. Example: [{"name": "Water heater flush", "unit_price": 15000, "quantity": 1}]
taxobject- Tax settings for the option. When taxable is true, both tax_name and tax_rate are required. Example: {"name": "Sales tax", "rate": 8.5}
housecallpro_estimate_option_note_addAdd a note to an estimate option.WriteAdd Estimate Option Note
Add a note to an estimate option. Returns the created note. Use this to record context on an option.
Inputs
contentstringrequired- content. Example: Arrived on time, replaced valve.
estimate_idstringrequired- estimate id. Example: est_9a8b7c6d5e4f4a3b2c1d0e9f8a7b6c5d.
option_idstringrequired- option id. Example: opt_2c3d4e5f6a7b4c8d9e0f1a2b3c4d5e6f.
housecallpro_estimate_options_approveMark estimate options as approved by the customer.WriteApprove Estimate Options
Mark estimate options as approved by the customer. Returns the approved options. Use this when the customer accepts a quote. Use housecallpro_estimate_options_decline otherwise.
Inputs
option_idsarrayrequired- option ids. Example: ["opt_2c3d4e5f6a7b4c8d9e0f1a2b3c4d5e6f"]
housecallpro_estimate_options_declineMark estimate options as declined.WriteDecline Estimate Options
Mark estimate options as declined. Returns the declined options. Use this when the customer rejects a quote.
Inputs
option_idsarrayrequired- option ids. Example: ["opt_2c3d4e5f6a7b4c8d9e0f1a2b3c4d5e6f"]
housecallpro_job_appointment_createAdd an appointment (visit) to a job with employees dispatched to it.WriteCreate Job Appointment
Add an appointment (visit) to a job with employees dispatched to it. Returns the created appointment. Use this for multi-visit jobs. Use housecallpro_job_schedule_update for a single-visit job.
Inputs
dispatched_employees_idsarrayrequired- List of pros ids to be assign in appointment. Example: ["pro_5c6d7e8f9a0b"]
end_timestringrequired- End time of job appointment in iso8601. Example: 2026-01-15T18:00:00Z.
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
start_timestringrequired- Start time of job appointment in iso8601. Example: 2026-01-15T16:00:00Z.
arrival_window_minutesinteger- Integer value in minutes of arrival window. Example: 60.
housecallpro_job_appointment_updateReschedule an appointment or change its employees.WriteUpdate Job Appointment
Reschedule an appointment or change its employees. Returns the updated appointment. Use this to move a visit.
- Idempotent
Inputs
appointment_idstringrequired- appointment id. Example: apt_5e6f7a8b9c0d4e1f2a3b4c5d6e7f8a9b.
dispatched_employees_idsarrayrequired- List of pros ids to be assign in appointment. Example: ["pro_5c6d7e8f9a0b"]
end_timestringrequired- End time of job appointment in iso8601. Example: 2026-01-15T18:00:00Z.
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
start_timestringrequired- Start time of job appointment in iso8601. Example: 2026-01-15T16:00:00Z.
arrival_window_minutesinteger- Integer value in minutes of arrival window. Example: 60.
housecallpro_job_createCreate a job for a customer at one of their addresses, with optional schedule, assigned employees, line items, tags and notes.WriteCreate Job
Create a job for a customer at one of their addresses, with optional schedule, assigned employees, line items, tags and notes. Returns the created job. Use this to book work. Use housecallpro_estimate_create for a quote.
Inputs
address_idstringrequired- address id. Example: adr_1f2e3d4c5b6a4987a6b5c4d3e2f1a0b9.
customer_idstringrequired- customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
assigned_employee_idsarray- assigned employee ids. Example: ["pro_5c6d7e8f9a0b"]
invoice_numbernumber- Invoice number must be unique across all of a company's jobs in Housecall Pro. If left blank, one will be automatically generated. Example: 1001.
job_fieldsobject- job fields. Example: {"job_type_id": "jt_1b2c3d4e5f6a47b8c9d0e1f2a3b4c5d6"}
lead_sourcestring- lead source. Example: Google.
line_itemsarray- line items. Example: [{"name": "Water heater flush", "unit_price": 15000, "quantity": 1}]
notesstring- notes. Example: Gate code 1234.
scheduleobject- schedule. Example: {"scheduled_start": "2026-01-15T16:00:00Z", "scheduled_end": "2026-01-15T18:00:00Z", "arrival_window": 60}
tagsarray- tags. Example: ["VIP"]
housecallpro_job_dispatchDispatch a job to employees, replacing the current assignment.WriteDispatch Job
Dispatch a job to employees, replacing the current assignment. Returns the updated dispatch list. Use this to assign technicians.
- Idempotent
Inputs
dispatched_employeesarrayrequired- dispatched employees. Example: ["pro_5c6d7e8f9a0b"]
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
housecallpro_job_line_item_addAdd a line item (service, material or fee) to a job.WriteAdd Job Line Item
Add a line item (service, material or fee) to a job. Prices are in cents. Returns the created line item. Use this to bill extra work.
Inputs
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
namestringrequired- name. Example: sk-test item.
descriptionstring- description. Example: Flush and inspect tank.
kindstring- kind. One of: materials, labor, fixed gratuity, fixed discount, percent discount. Example: labor.one of
materialslaborfixed gratuityfixed discountpercent discount quantitynumber- The number of items being solid. This can be a float up to two decmial places. Example: 1.
service_item_idstring- ID of the service item this line item is based on, if applicable. Example: pbsvc_1a2b3c4d5e6f.
service_item_typestring- service item type. One of: market_place, organizational, pricebook_material. Example: pricebook_material.one of
market_placeorganizationalpricebook_material taxableboolean- taxable. Example: true.
unit_costnumber- Direct cost to the company of a singe unit in cents. This value is used for job costing. Example: 5000.
unit_pricenumber- Selling price of a singe unit in cents. Example: 15000.
housecallpro_job_line_item_updateUpdate one line item on a job.WriteUpdate Job Line Item
Update one line item on a job. Returns the updated line item. Use this to change price or quantity.
- Idempotent
Inputs
idstringrequired- id. Example: li_9a8b7c6d5e4f.
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
namestringrequired- name. Example: sk-test item.
descriptionstring- description. Example: Flush and inspect tank.
kindstring- kind. One of: materials, labor, fixed gratuity, fixed discount, percent discount. Example: labor.one of
materialslaborfixed gratuityfixed discountpercent discount quantitynumber- quantity. Example: 1.
service_item_idstring- service item id. Example: pbsvc_1a2b3c4d5e6f.
service_item_typestring- service item type. One of: market_place, organizational, pricebook_material. Example: pricebook_material.one of
market_placeorganizationalpricebook_material taxableboolean- taxable. Example: true.
unit_costnumber- unit cost. Example: 5000.
unit_pricenumber- unit price. Example: 15000.
housecallpro_job_note_addAdd a private note to a job.WriteAdd Job Note
Add a private note to a job. Returns the created note. Use this to record context on a job.
Inputs
contentstringrequired- content. Example: Arrived on time, replaced valve.
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
housecallpro_job_schedule_updateSet or change a job's schedule (start, end, arrival window) and dispatched employees, optionally notifying the customer.WriteUpdate Job Schedule
Set or change a job's schedule (start, end, arrival window) and dispatched employees, optionally notifying the customer. Returns the updated job schedule. Use this to schedule or reschedule a job.
- Idempotent
Inputs
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
start_timestringrequired- Start time of job in iso8601. Example: 2026-01-15T16:00:00Z.
arrival_window_in_minutesnumber- Integer value in minutes of arrival window. Example: 60.
dispatched_employeesarray- dispatched employees. Example: ["pro_5c6d7e8f9a0b"]
end_timestring- End time of job in iso8601. Example: 2026-01-15T18:00:00Z.
expandarray- expand. Example: ["attachments"]
notifyboolean- Notify the customer of the update schedule. Example: true.
notify_proboolean- Notify the employee of the update schedule. Example: true.
housecallpro_job_tag_addAdd an existing tag to a job.WriteAdd Job Tag
Add an existing tag to a job. Returns the job's tags. Use housecallpro_tags_list for tag IDs.
Inputs
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
tag_idstringrequired- tag id. Example: tag_3e4f5a6b7c8d4e9f0a1b2c3d4e5f6a7b.
housecallpro_job_type_createCreate a job type.WriteCreate Job Type
Create a job type. Returns the created job type. Use this to categorize jobs.
Inputs
namestringrequired- name. Example: sk-test maintenance.
housecallpro_job_type_updateRename a job type.WriteUpdate Job Type
Rename a job type. Returns the updated job type. Use this to change a job type.
- Idempotent
Inputs
job_type_idstringrequired- job type id. Example: jt_1b2c3d4e5f6a47b8c9d0e1f2a3b4c5d6.
namestringrequired- name. Example: sk-test annual maintenance.
housecallpro_lead_convertConvert a lead into an estimate or a job.WriteConvert Lead
Convert a lead into an estimate or a job. Returns the created estimate or job. Use this once the lead is qualified.
Inputs
idstringrequired- id. Example: lead_3c4d5e6f7a8b4c9d0e1f2a3b4c5d6e7f.
typestring- The type to convert the lead to. Must be either "estimate" or "job". One of: estimate, job. Example: job.one of
estimatejob
housecallpro_lead_createCreate a lead for an existing customer (customer_id) or a new one (customer object), with address, line items, lead source and note.WriteCreate Lead
Create a lead for an existing customer (customer_id) or a new one (customer object), with address, line items, lead source and note. Returns the created lead. Use this to capture a new inquiry. Use housecallpro_lead_convert to turn it into a job or estimate.
Inputs
addressobject- address. Example: {"street": "123 Main St", "city": "San Francisco", "state": "CA", "zip": "94105"}
address_idstring- address id. Example: adr_1f2e3d4c5b6a4987a6b5c4d3e2f1a0b9.
assigned_employee_idstring- assigned employee id. Example: pro_5c6d7e8f9a0b.
customerobject- Either this or Customer ID required. Example: {"first_name": "Jane", "last_name": "Doe", "email": "jane.doe@example.com"}
customer_idstring- Either this or Customer required. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
lead_sourcestring- lead source. Example: Google.
line_itemsarray- line items. Example: [{"name": "Water heater flush", "unit_price": 15000, "quantity": 1}]
notestring- note. Example: Customer prefers mornings.
tagsarray- tags. Example: ["VIP"]
tax_namestring- tax name. Example: Sales tax.
tax_rateinteger- tax rate. Example: 8.
housecallpro_lead_source_createCreate a lead source.WriteCreate Lead Source
Create a lead source. Returns the created lead source. Use this to track a new marketing channel.
Inputs
namestringrequired- name. Example: sk-test referral.
housecallpro_lead_source_updateRename a lead source.WriteUpdate Lead Source
Rename a lead source. Returns the updated lead source. Use this to fix a name.
- Idempotent
Inputs
lead_source_idstringrequired- lead source id. Example: ls_0a1b2c3d4e5f46a7b8c9d0e1f2a3b4c5.
namestring- name. Example: sk-test referral program.
housecallpro_material_createAdd a material to the price book in a category.WriteCreate Price Book Material
Add a material to the price book in a category. Price and cost are in cents. Returns the created material. Use this to add parts to the catalog.
Inputs
costintegerrequired- cost of the material to be created in cents. Example: 5000.
material_category_uuidstringrequired- UUID of the material category to create this material under. Example: pbmcat_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6.
material_category_uuid_bodystringrequired- UUID of the material category to create this material under. Example: pbmcat_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6.
namestringrequired- name of the material to be created. Example: sk-test valve.
priceintegerrequired- price of the material to be created in cents. Example: 15000.
descriptionstring- description of the material to be created. Example: Flush and inspect tank.
flat_rate_enabledboolean- flat rate enabled. Example: true.
part_numberstring- part number of the material to be created. Example: WH-VALVE-01.
taxableboolean- if the material should be taxable on invoice. Example: true.
unit_of_measurestring- unit of measure of the material to be created (i.e. each). Example: each.
housecallpro_pipeline_status_updateMove a lead, estimate or job to a pipeline status.WriteUpdate Pipeline Status
Move a lead, estimate or job to a pipeline status. Returns the updated resource status. Use this to advance a deal through the pipeline.
- Idempotent
Inputs
resource_idstringrequired- the UUID of the resource. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
resource_typestringrequired- resource type. One of: lead, job, estimate. Example: job.one of
leadjobestimate status_idstringrequired- the UUID of the pipeline status. Example: pst_1a2b3c4d5e6f.
housecallpro_tag_createCreate a tag.WriteCreate Tag
Create a tag. Returns the created tag. Use this before tagging jobs or customers.
Inputs
namestring- name. Example: sk-test VIP.
housecallpro_tag_updateRename or recolor a tag.WriteUpdate Tag
Rename or recolor a tag. Returns the updated tag. Use this to change a tag.
- Idempotent
Inputs
tag_idstringrequired- tag id. Example: tag_3e4f5a6b7c8d4e9f0a1b2c3d4e5f6a7b.
namestring- name. Example: sk-test VIP customer.
housecallpro_job_appointment_deleteDelete an appointment from a job.DestructiveDelete Job Appointment
Delete an appointment from a job. Returns an empty response on success. Use this to cancel one visit.
- Idempotent
Inputs
appointment_idstringrequired- appointment id. Example: apt_5e6f7a8b9c0d4e1f2a3b4c5d6e7f8a9b.
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
housecallpro_job_line_item_deleteDelete one line item from a job.DestructiveDelete Job Line Item
Delete one line item from a job. Returns an empty response on success. Use this to remove a charge.
- Idempotent
Inputs
idstringrequired- id. Example: li_9a8b7c6d5e4f.
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
housecallpro_job_note_deleteDelete a note from a job.DestructiveDelete Job Note
Delete a note from a job. Returns an empty response on success. Use this to remove a note.
- Idempotent
Inputs
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
note_idstringrequired- note id. Example: nte_7a6b5c4d3e2f4a1b0c9d8e7f6a5b4c3d.
housecallpro_job_tag_removeRemove a tag from a job.DestructiveRemove Job Tag
Remove a tag from a job. Returns an empty response on success. Use this to untag a job.
- Idempotent
Inputs
job_idstringrequired- job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
tag_idstringrequired- tag id. Example: tag_3e4f5a6b7c8d4e9f0a1b2c3d4e5f6a7b.
housecallpro_material_deleteDelete a price book material.DestructiveDelete Price Book Material
Delete a price book material. Returns an empty response on success. Use this to retire a part.
- Idempotent
Inputs
uuidstringrequired- UUID of the material to be updated. Example: pbmat_8f7e6d5c4b3a4f2e1d0c9b8a7f6e5d4c.
No tools match.