Skip to content
Documentation
Contact
← Back to documentation
Technical Reference

Housecall Pro

Manage your home service business with Housecall Pro CRM integration

CategorySales And Crm
Authenticationcustom
Version0.2.0
Published scopes0 published scopes
Last updatedSeptember 19, 2026

Overview

Connect Housecall Pro with Flows360

Manage your home service business with Housecall Pro CRM integration

Use the Housecall Pro connector to include its declared actions and events in Flows360 workflows without duplicating the integration logic inside each consuming system. This pinned connector version currently exposes 46 actions and no declared triggers.

Available actions

  • Create Customer
  • Get Customers
  • Get Customer
  • Update Customer
  • Get All of a Customer's Addresses
  • Create an Address on a Customer
  • Get a Customer's Address
  • Create Job
  • Plus 38 additional declared actions.

Available triggers

  • No triggers are declared in this pinned package.

The capability list above is generated from the exact reviewed connector package so the public description stays aligned with the version Flows360 operates.

Technical guide

Technical reference

Package identity

  • Connector: Housecall Pro
  • Package: @activepieces/piece-housecall-pro@0.2.0
  • Exact artifact digest: sha256:714f2ab3fb69b8977f609d059ba1a487b753767df2ebf803bbd8fc345220af1a
  • Runtime: Activepieces-compatible deterministic worker
  • Source: the exact reviewed Activepieces source

Authentication

SECRET TEXT. Connection values are tenant-specific and remain in the consuming Studio instance; CDK stores definitions and field metadata, not customer credential values.

Action contracts

  • Create Customer (create_customer), Creates a new customer in Housecall Pro. Classification: read.
  • Get Customers (get_customers), Retrieves a list of customers from Housecall Pro. Classification: read.
  • Get Customer (get_customer), Retrieves the customer by ID. Classification: read.
  • Update Customer (update_customer), Updates an existing customer in Housecall Pro. Classification: read.
  • Get All of a Customer's Addresses (get_customer_addresses), Retrieves all of a customer's addresses. Classification: read.
  • Create an Address on a Customer (create_customer_address), Creates an address on a customer. Classification: read.
  • Get a Customer's Address (get_customer_address), Retrieves a customer's address by customer ID and address ID. Classification: read.
  • Create Job (create_job), Creates a job with the ID for an already existing address and customer. Classification: read.
  • Get Jobs (get_jobs), Retrieve a list of jobs from Housecall Pro. Classification: read.
  • Get a Job (get_job), Retrieves a single job by ID from Housecall Pro. Classification: read.
  • Update Job Schedule (update_job_schedule), Updates a job's schedule. Jobs with multi days feature containing more than 1 appointment can't be updated through this action. Classification: read.
  • Delete Job Schedule (delete_job_schedule), Deletes schedule on a job. Classification: read.
  • Create appointment (create_job_appointment), Add an appointment to a job Classification: read.
  • Get Appointments (get_job_appointments), Get all of the appointments for a job Classification: read.
  • Update Appointment (update_job_appointment), Update job appointment Classification: read.
  • Delete appointment (delete_job_appointment), Delete a job appointment Classification: read.
  • Add job note (add_job_note), Add a note to a job Classification: read.
  • Delete job note (delete_job_note), Delete a specific job note Classification: read.
  • Add an attachment to a job (add_job_attachment), Upload an attachment to a job Classification: read.
  • Add a line item to a job (add_job_line_item), Add a line item to a job. This is a rate limited request. Classification: read.
  • Update a single line item for a job (update_job_line_item), Update a specific line item for a job Classification: read.
  • Delete a single line item for a job (delete_job_line_item), Delete a specific line item from a job Classification: read.
  • Lists all line items for a job (get_job_line_items), Retrieve all line items for a specific job Classification: read.
  • Add job tag (add_job_tag), Add a tag to a job Classification: read.
  • Remove job tag (remove_job_tag), Remove a tag from a job Classification: read.
  • Create Job Link (create_job_link), Create a new job link Classification: read.
  • Get Job Invoices (get_job_invoices), Lists all invoices for a job Classification: read.
  • Lists all job input materials for a job (get_job_input_materials), Retrieve all job input materials for a specific job Classification: read.
  • Bulk update a job's line items (bulk_update_job_line_items), Bulk update job line items. If upsert not define for a line item it will be considered as a new line item for the job. Classification: read.
  • Bulk update a job's input materials (bulk_update_job_input_materials), Bulk update job input materials. If upsert not define for a job input material it will be consider as a new entry. Classification: read.
  • Dispatch job to employees (dispatch_job_to_employees), Dispatch a job to employees Classification: read.
  • Lock Job (lock_job), Lock the job identified by the given job_id Classification: read.
  • Lock Jobs (lock_jobs), Lock completed or scheduled jobs by the given time range Classification: read.
  • Create estimate (create_estimate), Create an estimate Classification: read.
  • Get estimate by ID (get_estimate), Retrieve a single estimate by ID Classification: read.
  • Get estimates (get_estimates), Get a list of estimates with filtering and pagination Classification: read.
  • Create estimate option note (create_estimate_option_note), Create a new estimate option note Classification: read.
  • Delete estimate option note (delete_estimate_option_note), Delete a specific estimate option note Classification: read.
  • Create estimate option attachment (create_estimate_option_attachment), Upload an attachment to an estimate option Classification: read.
  • Create estimate option link (create_estimate_option_link), Create a new estimate option link Classification: read.
  • Update estimate option schedule (update_estimate_option_schedule), Update an estimate option's schedule. Classification: read.
  • Create Lead (create_lead), Create a lead with the ID for an already existing customer. Classification: read.
  • Get Lead (get_lead), Get the lead via ID. Classification: read.
  • Get Leads (get_leads), Get a list of leads Classification: read.
  • Convert Lead to Estimate or Job (convert_lead_to_estimate_or_job), Converts a lead into an estimate or job. Classification: read.
  • Custom API Call (custom_api_call), Make a custom API call to a specific endpoint Classification: read.

Trigger contracts

  • No trigger delivery contracts are declared.

Verification

Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Capability summary

Authenticationcustom
Supported objects46
Supported actions46
TriggersNone published

Authentication

Authentication method: custom

Authentication profiles

connection · custom
  • API Key Required · protected credential

Supported objects

ObjectReadWriteNotes
Create Customer Yes No Creates a new customer in Housecall Pro.
Get Customers Yes No Retrieves a list of customers from Housecall Pro.
Get Customer Yes No Retrieves the customer by ID.
Update Customer Yes No Updates an existing customer in Housecall Pro.
Get All of a Customer's Addresses Yes No Retrieves all of a customer's addresses.
Create an Address on a Customer Yes No Creates an address on a customer.
Get a Customer's Address Yes No Retrieves a customer's address by customer ID and address ID.
Create Job Yes No Creates a job with the ID for an already existing address and customer.
Get Jobs Yes No Retrieve a list of jobs from Housecall Pro.
Get a Job Yes No Retrieves a single job by ID from Housecall Pro.
Update Job Schedule Yes No Updates a job's schedule. Jobs with multi days feature containing more than 1 appointment can't be updated through this action.
Delete Job Schedule Yes No Deletes schedule on a job.
Create appointment Yes No Add an appointment to a job
Get Appointments Yes No Get all of the appointments for a job
Update Appointment Yes No Update job appointment
Delete appointment Yes No Delete a job appointment
Add job note Yes No Add a note to a job
Delete job note Yes No Delete a specific job note
Add an attachment to a job Yes No Upload an attachment to a job
Add a line item to a job Yes No Add a line item to a job. This is a rate limited request.
Update a single line item for a job Yes No Update a specific line item for a job
Delete a single line item for a job Yes No Delete a specific line item from a job
Lists all line items for a job Yes No Retrieve all line items for a specific job
Add job tag Yes No Add a tag to a job
Remove job tag Yes No Remove a tag from a job
Create Job Link Yes No Create a new job link
Get Job Invoices Yes No Lists all invoices for a job
Lists all job input materials for a job Yes No Retrieve all job input materials for a specific job
Bulk update a job's line items Yes No Bulk update job line items. If upsert not define for a line item it will be considered as a new line item for the job.
Bulk update a job's input materials Yes No Bulk update job input materials. If upsert not define for a job input material it will be consider as a new entry.
Dispatch job to employees Yes No Dispatch a job to employees
Lock Job Yes No Lock the job identified by the given job_id
Lock Jobs Yes No Lock completed or scheduled jobs by the given time range
Create estimate Yes No Create an estimate
Get estimate by ID Yes No Retrieve a single estimate by ID
Get estimates Yes No Get a list of estimates with filtering and pagination
Create estimate option note Yes No Create a new estimate option note
Delete estimate option note Yes No Delete a specific estimate option note
Create estimate option attachment Yes No Upload an attachment to an estimate option
Create estimate option link Yes No Create a new estimate option link
Update estimate option schedule Yes No Update an estimate option's schedule.
Create Lead Yes No Create a lead with the ID for an already existing customer.
Get Lead Yes No Get the lead via ID.
Get Leads Yes No Get a list of leads
Convert Lead to Estimate or Job Yes No Converts a lead into an estimate or job.
Custom API Call Yes No Make a custom API call to a specific endpoint

Supported actions

Create Customer · Read

Creates a new customer in Housecall Pro.

create_customer · Risk: low · Retry: safe

Inputs

  • info · string · Optional, At least one of: First Name, Last Name, Email, Mobile Number, Home Number, Work Number is required.
  • first_name · string · Optional
  • last_name · string · Optional
  • email · string · Optional
  • mobile_number · string · Optional
  • home_number · string · Optional
  • work_number · string · Optional
  • company · string · Optional
  • notifications_enabled · boolean · Optional, Will the customer receive notifications
  • lead_source · string · Optional
  • notes · string · Optional
  • tags · array · Optional, Array of tags to assign to the customer
  • addresses · array · Optional, Array of address objects
Get Customers · Read

Retrieves a list of customers from Housecall Pro.

get_customers · Risk: low · Retry: safe

Inputs

  • page · number · Optional, Page number for pagination (starts from 1)
  • page_size · number · Optional, Number of customers per page (max 100)
  • q · string · Optional, Search customers by name, email, mobile number, and address
  • expand · array · Optional, Expand related data
  • location_ids · array · Optional, IDs of locations from which to pull customers
  • sort_by · string · Optional, The customer attribute by which to sort the results
  • sort_direction · string · Optional, The order of sorting (ascending or descending)
Get Customer · Read

Retrieves the customer by ID.

get_customer · Risk: low · Retry: safe

Inputs

  • customer_id · string · Required, The ID of the customer to retrieve.
  • expand · array · Optional, Expand related data
Update Customer · Read

Updates an existing customer in Housecall Pro.

update_customer · Risk: low · Retry: safe

Inputs

  • customer_id · string · Required, The ID of the customer to update.
  • first_name · string · Optional
  • last_name · string · Optional
  • email · string · Optional
  • mobile_number · string · Optional
  • home_number · string · Optional
  • work_number · string · Optional
  • company · string · Optional
  • notes · string · Optional
  • tags · array · Optional, Array of tags to assign to the customer (replaces existing tags)
  • notifications_enabled · boolean · Optional, Will the customer receive notifications
  • lead_source · string · Optional
  • addresses · array · Optional, Array of address objects (if provided, each address must include an id)
Get All of a Customer's Addresses · Read

Retrieves all of a customer's addresses.

get_customer_addresses · Risk: low · Retry: safe

Inputs

  • customer_id · string · Required, The ID of the customer
  • page · number · Optional, Paginated page number
  • page_size · number · Optional, Number of addresses returned per page
  • sort_by · string · Optional, Address attribute to sort by
  • sort_direction · string · Optional, Ascending or descending
Create an Address on a Customer · Read

Creates an address on a customer.

create_customer_address · Risk: low · Retry: safe

Inputs

  • customer_id · string · Required, The ID of the customer to add address to
  • street · string · Required, Street address
  • street_line_2 · string · Optional, Additional street address line
  • city · string · Required, City
  • state · string · Required, State
  • zip · string · Required, ZIP code
  • country · string · Required, Country
  • latitude · number · Optional, Latitude (one of number)
  • longitude · number · Optional, Longitude (one of number)
Get a Customer's Address · Read

Retrieves a customer's address by customer ID and address ID.

get_customer_address · Risk: low · Retry: safe

Inputs

  • customer_id · string · Required, The ID of the customer
  • address_id · string · Required, The ID of the address
Create Job · Read

Creates a job with the ID for an already existing address and customer.

create_job · Risk: low · Retry: safe

Inputs

  • customer_id · string · Required, The ID of the customer this job is for
  • address_id · string · Required, The ID of the address for this job
  • invoice_number · number · Optional, Invoice number must be unique across all of a company's jobs. If left blank, one will be automatically generated.
  • scheduled_start · string · Optional, Start time of job in ISO8601 format (e.g., 2021-01-14T20:14:00)
  • scheduled_end · string · Optional, End time of job in ISO8601 format (e.g., 2021-01-14T21:14:00)
  • arrival_window · number · Optional, Integer value in minutes of arrival window
  • assigned_employee_ids · array · Optional, Array of employee IDs to assign to the job
  • tags · array · Optional, Array of tags to assign to the job
  • lead_source · string · Optional
  • notes · string · Optional
  • line_items · array · Optional, Array of line items for the job
  • pricing_form · object · Optional, Pricing form object with fields and options (use UUIDs from GET price form endpoint)
  • job_fields · object · Optional, Job fields object (e.g., job_type_id, business_unit_id)
Get Jobs · Read

Retrieve a list of jobs from Housecall Pro.

get_jobs · Risk: low · Retry: safe

Inputs

  • customer_id · string · Optional, Filters jobs by a single customer ID
  • employee_ids · array · Optional, Array of employee IDs to filter jobs
  • expand · array · Optional, Array of strings to expand response body
  • location_ids · array · Optional, IDs of locations to retrieve jobs from
  • page · number · Optional, The paginated page number
  • page_size · number · Optional, The number of jobs returned per page
  • scheduled_start_min · string · Optional, Filters jobs with a starting time greater than or equal to the date sent
  • scheduled_start_max · string · Optional, Filters jobs with a starting time less than or equal to the date sent
  • scheduled_end_min · string · Optional, Filters jobs with an end time greater than or equal to the date sent
  • scheduled_end_max · string · Optional, Filters jobs with an end time less than or equal to the date sent
  • sort_by · string · Optional, The attribute to sort the results by
  • sort_direction · string · Optional, The sorting order
  • work_status · array · Optional, Filters jobs by their work status. If empty, returns jobs from all statuses
Get a Job · Read

Retrieves a single job by ID from Housecall Pro.

get_job · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job to retrieve
  • expand · array · Optional, Expand related data (attachments, appointments)
Update Job Schedule · Read

Updates a job's schedule. Jobs with multi days feature containing more than 1 appointment can't be updated through this action.

update_job_schedule · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job to update schedule for
  • start_time · string · Required, Start time of job in ISO8601 format (e.g., 2021-01-14T20:14:00)
  • end_time · string · Required, End time of job in ISO8601 format (e.g., 2021-01-14T21:14:00)
  • arrival_window_in_minutes · number · Optional, Integer value in minutes of arrival window
  • notify · boolean · Optional, Notify the customer of the update schedule
  • notify_pro · boolean · Optional, Notify the pros of the update schedule
  • expand · array · Optional, Expand related entities
  • dispatched_employees · array · Optional, Array of employee objects with employee_id
Delete Job Schedule · Read

Deletes schedule on a job.

delete_job_schedule · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job to delete schedule from.
Create appointment · Read

Add an appointment to a job

create_job_appointment · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job
  • start_time · string · Required, Start time of job appointment in iso8601
  • end_time · string · Required, End time of job appointment in iso8601
  • arrival_window_minutes · number · Optional, Integer value in minutes of arrival window
  • dispatched_employees_ids · array · Required, List of pros ids to be assign in appointment
Get Appointments · Read

Get all of the appointments for a job

get_job_appointments · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job
Update Appointment · Read

Update job appointment

update_job_appointment · Risk: low · Retry: safe

Inputs

  • appointment_id · string · Required, The ID of the appointment
  • job_id · string · Required, The ID of the job
  • start_time · string · Required, Start time of job appointment in iso8601
  • end_time · string · Required, End time of job appointment in iso8601
  • arrival_window_minutes · number · Optional, Integer value in minutes of arrival window
  • dispatched_employees_ids · array · Required, List of pros ids to be assign in appointment
Delete appointment · Read

Delete a job appointment

delete_job_appointment · Risk: low · Retry: safe

Inputs

  • appointment_id · string · Required, The ID of the appointment
  • job_id · string · Required, The ID of the job
Add job note · Read

Add a note to a job

add_job_note · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job
  • content · string · Required, The content of the note
Delete job note · Read

Delete a specific job note

delete_job_note · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job
  • note_id · string · Required, The ID of the note to delete
Add an attachment to a job · Read

Upload an attachment to a job

add_job_attachment · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job to add attachment to
  • file · object · Required, The file to upload
Add a line item to a job · Read

Add a line item to a job. This is a rate limited request.

add_job_line_item · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job
  • name · string · Required, The name of the line item
  • description · string · Optional, The description of the line item
  • unit_price · number · Optional, The unit price of the line item
  • unit_cost · number · Optional, The unit cost of the line item
  • quantity · number · Optional, The number of items being sold. This can be a float up to two decimal places
  • tax_surcharge_type · string · Optional, The type of tax or surcharge
  • kind · string · Optional, The kind of line item
  • taxable · boolean · Optional, Whether the line item is taxable
  • service_line_id · string · Optional, The ID of the service line
  • service_line_type · string · Optional, The type of service line
Update a single line item for a job · Read

Update a specific line item for a job

update_job_line_item · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job
  • id · string · Required, The ID of the line item
  • service_line_id · string · Optional, The ID of the service line
  • service_line_type · string · Optional, The type of service line
  • name · string · Optional, The name of the line item
  • unit_price · number · Optional, The unit price of the line item
  • unit_cost · number · Optional, The unit cost of the line item
  • quantity · number · Optional, The number of items being sold
  • kind · string · Optional, The kind of line item
  • taxable · boolean · Optional, Whether the line item is taxable
  • description · string · Optional, The description of the line item
Delete a single line item for a job · Read

Delete a specific line item from a job

delete_job_line_item · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job
  • id · string · Required, The ID of the line item to delete
Lists all line items for a job · Read

Retrieve all line items for a specific job

get_job_line_items · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job
Add job tag · Read

Add a tag to a job

add_job_tag · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job
  • tag_id · string · Required, The ID of the tag to add
Remove job tag · Read

Remove a tag from a job

remove_job_tag · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job
  • tag_id · string · Required, The ID of the tag to remove
Create Job Link · Read

Create a new job link

create_job_link · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job
  • title · string · Required, The title of the link
  • url · string · Required, The URL of the link
Get Job Invoices · Read

Lists all invoices for a job

get_job_invoices · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job to retrieve invoices for
Lists all job input materials for a job · Read

Retrieve all job input materials for a specific job

get_job_input_materials · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job
Bulk update a job's line items · Read

Bulk update job line items. If upsert not define for a line item it will be considered as a new line item for the job.

bulk_update_job_line_items · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job
  • line_items · array · Required, Array of line items to update
  • append_line_items · boolean · Optional, Append line items to the job
Bulk update a job's input materials · Read

Bulk update job input materials. If upsert not define for a job input material it will be consider as a new entry.

bulk_update_job_input_materials · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job
  • job_input_materials · array · Required, Array of job input materials to update
Dispatch job to employees · Read

Dispatch a job to employees

dispatch_job_to_employees · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job to dispatch
  • dispatched_employees · array · Required, Array of employees with employee_id to dispatch to
Lock Job · Read

Lock the job identified by the given job_id

lock_job · Risk: low · Retry: safe

Inputs

  • job_id · string · Required, The ID of the job to lock
Lock Jobs · Read

Lock completed or scheduled jobs by the given time range

lock_jobs · Risk: low · Retry: safe

Inputs

  • starting_at · string · Required, Lock jobs starting from this date/time
  • ending_at · string · Required, Lock jobs until this date/time
Create estimate · Read

Create an estimate

create_estimate · Risk: low · Retry: safe

Inputs

  • estimate_number · number · Optional, Unique estimate number. If blank, one will be automatically generated.
  • message · string · Optional
  • customer_id · string · Optional
  • assigned_employee_ids · array · Optional
  • address_id · string · Optional
  • address · object · Optional, Address object with fields: street, street_line_2, city, state, zip
  • schedule · object · Optional, Schedule object with fields: start_time, end_time, arrival_window_in_minutes, notify_customer
  • estimate_fields · object · Optional, Estimate fields object with: job_type_id, business_unit_id
  • options · array · Optional, Each option object corresponds to an estimate option to create.
  • additional_fields · object · Optional, Advanced: provide raw fields merged into the request body.
Get estimate by ID · Read

Retrieve a single estimate by ID

get_estimate · Risk: low · Retry: safe

Inputs

  • estimate_id · string · Required
  • expand · array · Optional
Get estimates · Read

Get a list of estimates with filtering and pagination

get_estimates · Risk: low · Retry: safe

Inputs

  • customer_id · string · Optional, Filter estimates by a single customer ID
  • employee_ids · array · Optional, Filter estimates by assigned employee IDs
  • expand · array · Optional, Array of strings to expand response body
  • location_ids · array · Optional, IDs of locations to retrieve estimates from
  • page · number · Optional, The paginated page number
  • page_size · number · Optional, The number of estimates returned per page
  • scheduled_end_max · string · Optional, Filters estimates with an end time less than or equal to the date sent
  • scheduled_end_min · string · Optional, Filters estimates with an end time greater than or equal to the date sent
  • scheduled_start_max · string · Optional, Filters estimates with a starting time less than or equal to the date sent
  • scheduled_start_min · string · Optional, Filters estimates with a starting time greater than or equal to the date sent
  • sort_by · string · Optional, The attribute to sort the results by
  • sort_direction · string · Optional, The sorting order
  • work_status · array · Optional, Filters estimates by their work status
Create estimate option note · Read

Create a new estimate option note

create_estimate_option_note · Risk: low · Retry: safe

Inputs

  • estimate_id · string · Required
  • option_id · string · Required
  • content · string · Required
Delete estimate option note · Read

Delete a specific estimate option note

delete_estimate_option_note · Risk: low · Retry: safe

Inputs

  • estimate_id · string · Required
  • option_id · string · Required
  • note_id · string · Required
Create estimate option attachment · Read

Upload an attachment to an estimate option

create_estimate_option_attachment · Risk: low · Retry: safe

Inputs

  • estimate_id · string · Required
  • option_id · string · Required
  • file · object · Required
Create estimate option link · Read

Create a new estimate option link

create_estimate_option_link · Risk: low · Retry: safe

Inputs

  • estimate_id · string · Required
  • option_id · string · Required
  • title · string · Required
  • url · string · Required
Update estimate option schedule · Read

Update an estimate option's schedule.

update_estimate_option_schedule · Risk: low · Retry: safe

Inputs

  • estimate_id · string · Required
  • option_id · string · Required
  • start_time · string · Required
  • end_time · string · Required
  • arrival_window_in_minutes · number · Required
  • notify · boolean · Required
  • notify_pro · boolean · Required
  • expand · array · Optional
  • dispatched_employees · array · Optional, Array of objects with employee_id
Create Lead · Read

Create a lead with the ID for an already existing customer.

create_lead · Risk: low · Retry: safe

Inputs

  • customer_id · string · Required, Either the ID of customer required
  • customer · object · Optional, Either the ID of customer required
  • first_name · string · Optional
  • last_name · string · Optional
  • email · string · Optional
  • notifications_enabled · boolean · Optional, Will the customer receive notifications
  • mobile_number · string · Optional
  • home_number · string · Optional
  • work_number · string · Optional
  • lead_source · string · Optional
  • notes · string · Optional
  • tags · array · Optional
  • addresses · array · Optional
  • assigned_employees · array · Optional
Get Lead · Read

Get the lead via ID.

get_lead · Risk: low · Retry: safe

Inputs

  • id · string · Required
Get Leads · Read

Get a list of leads

get_leads · Risk: low · Retry: safe

Inputs

  • customer_id · string · Optional, Filter leads by a single customer ID (String)
  • employee_ids · array · Optional, Filter leads by a list of employee IDs (String array)
  • lead_source · string · Optional, Filter leads by a single lead_source
  • location_ids · array · Optional, If a location you want to get from / If a Company-kit header is set, location_ids will be ignored
  • page · number · Optional, Paginated page number
  • page_size · number · Optional, Number of leads returned per page
  • sort_by · string · Optional, Attribute to sort by
  • sort_direction · string · Optional, Allowed values: asc, desc
  • status · string · Optional, Filter leads by status
  • tag_ids · array · Optional, Filter leads by a list of tags
Convert Lead to Estimate or Job · Read

Converts a lead into an estimate or job.

convert_lead_to_estimate_or_job · Risk: low · Retry: safe

Inputs

  • id · string · Required
  • type · string · Required, The type to convert the lead to. Must be either 'estimate' or 'job'
Custom API Call · Read

Make a custom API call to a specific endpoint

custom_api_call · Risk: low · Retry: safe

Inputs

  • url · object · Required
  • method · string · Required
  • headers · object · Optional, Authorization headers are injected automatically from your connection.
  • queryParams · object · Optional, Appended to the URL as ?key=value.
  • body_type · string · Optional
  • body · object · Optional
  • response_is_binary · boolean · Optional, Enable for files like PDFs, images, etc.
  • failsafe · boolean · Optional, On a failed request, output the error instead of failing the step.
  • timeout · number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).
  • followRedirects · boolean · Optional, Follow 3xx redirects instead of returning them as the response.

Setup

Setup

  1. Add the Housecall Pro connector to the workflow in the target Flows360 Studio instance.
  2. Create or select the tenant-specific connection required by the connector. Connection secrets remain in the Studio connection boundary and are not copied into CDK documentation.
  3. Provide the connection fields declared by the pinned package:
  • No provider credential fields are declared by the pinned package.
  1. Select the required action or trigger and complete its declared input fields. Required and optional inputs are defined by the exact package schema.
  2. Test the workflow in the appropriate environment before enabling production scheduling or event delivery.

Limitations

Limitations and operational notes

  • This content describes @activepieces/piece-housecall-pro@0.2.0; provider behaviour can change independently and should be revalidated when the provider or connector version changes.
  • Only the 46 actions and 0 triggers declared by this pinned package are represented here.
  • Tenant credentials and connection values are not stored in the public connector record.
  • Provider-side permissions, account entitlements, quotas and rate limits remain subject to the connected provider account and are not inferred when the package does not declare them.
  • Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Troubleshooting

Why canu2019t the connector authenticate?

Check the tenant connection in Studio and confirm every required Housecall Pro connection field is present. Re-authorise OAuth-based connections if the provider token or consent has expired. Do not place credential values in CDK content or logs.

Why is an action or trigger unavailable?

Confirm that the workflow is using @activepieces/piece-housecall-pro@0.2.0 and compare the requested capability with the declared action and trigger list for this version. A capability that is not declared by the pinned package should not be presented as supported.

What should I check after a provider-side change?

Revalidate authentication, required fields, action/trigger behaviour and provider documentation before publishing refreshed connector content or moving a new package version into production.

github.com