Housecall Pro
App · 20 actions
Read Housecall Pro jobs, customers, estimates, leads and invoices, and manage customer details and addresses.
Actions
| Action | What it does |
|---|---|
| Create customer | Create customer. |
| Create customer address | Create customer address. |
| Get company | Get company. |
| Get customer | Get customer. |
| Get estimate | Get estimate. |
| Get event | Get event. |
| Get invoice | Get invoice. |
| Get job | Get job. |
| Get lead | Get lead. |
| List customer addresses | List customer addresses. |
| List customers | List customers. |
| List employees | List employees. |
| List estimates | List estimates. |
| List events | List events. |
| List invoices | List invoices. |
| List job types | List job types. |
| List jobs | List jobs. |
| List lead sources | List lead sources. |
| List leads | List leads. |
| Update customer | Update customer. |
Create customer
Create customer.
Inputs
- First name
first_nametext - first_name.
- Last name
last_nametext - last_name.
- Email
emailtext - email.
- Company
companytext - company.
- Notifications enabled
notifications_enabledtrue/false - Will the customer receive notifications
- Mobile number
mobile_numbertext - mobile_number.
- Home number
home_numbertext - home_number.
- Work number
work_numbertext - work_number.
- Tags
tagslist - tags.
- Lead source
lead_sourcetext - lead_source.
- Notes
notestext - notes.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"addresses": [],
"attachments": [],
"company": "",
"company_id": "",
"company_name": "",
"created_at": "",
"do_not_service": false,
"email": "",
"first_name": "",
"home_number": "",
"id": "",
"last_name": "",
"lead_source": "",
"mobile_number": "",
"notes": "",
"notifications_enabled": false,
"tags": [],
"updated_at": "",
"work_number": ""
},
"has_more": false,
"next_cursor": null
}Create customer address
Create customer address.
Inputs
- Customer id
customer_idtextRequired - customer_id.
- Street
streettextRequired - street.
- Street line 2
street_line_2text - street_line_2.
- City
citytextRequired - city.
- State
statetextRequired - state.
- Zip
ziptextRequired - zip.
- Country
countrytextRequired - country.One of:
AF(Afghanistan),AX(Åland Islands),AL(Albania),DZ(Algeria),AD(Andorra),AO(Angola),AI(Anguilla),AQ(Antarctica),AG(Antigua & Barbuda),AR(Argentina), and 239 more.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"city": "",
"country": "",
"id": "",
"state": "",
"street": "",
"street_line_2": "",
"type": "billing",
"zip": ""
},
"has_more": false,
"next_cursor": null
}Get company
Get company.
Inputs
None.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"address": {
"city": "",
"country": "",
"latitude": 0,
"longitude": 0,
"state": "",
"street": "",
"street_line_2": "",
"zip": ""
},
"default_arrival_window": "",
"franchise_info": {
"franchisor_depth": 0,
"metadata": {},
"root_franchisor_id": ""
},
"id": "",
"locations": [],
"logo_url": "",
"name": "",
"phone_number": "",
"service_areas_data": {
"zip_codes": []
},
"support_email": "",
"time_zone": "",
"website": ""
},
"has_more": false,
"next_cursor": null
}Get customer
Get customer.
Inputs
- Customer id
customer_idtextRequired - customer_id.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"addresses": [],
"attachments": [],
"company": "",
"company_id": "",
"company_name": "",
"created_at": "",
"do_not_service": false,
"email": "",
"first_name": "",
"home_number": "",
"id": "",
"last_name": "",
"lead_source": "",
"mobile_number": "",
"notes": "",
"notifications_enabled": false,
"tags": [],
"updated_at": "",
"work_number": ""
},
"has_more": false,
"next_cursor": null
}Get estimate
Get estimate.
Inputs
- Estimate id
estimate_idtextRequired - estimate_id.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"address": {
"city": "",
"country": "",
"id": "",
"state": "",
"street": "",
"street_line_2": "",
"type": "billing",
"zip": ""
},
"assigned_employees": [],
"assigned_route_template_id": "",
"company_id": "",
"company_name": "",
"created_at": "",
"customer": {
"company": "",
"company_id": "",
"company_name": "",
"created_at": "",
"email": "",
"first_name": "",
"home_number": "",
"id": "",
"last_name": "",
"lead_source": "",
"mobile_number": "",
"notes": "",
"notifications_enabled": false,
"tags": [],
"updated_at": "",
"work_number": ""
},
"estimate_fields": {
"business_unit": {},
"job_type": {}
},
"estimate_number": "",
"id": "",
"lead_source": "",
"options": [],
"schedule": {
"appointments": [],
"arrival_window": 0,
"scheduled_end": "",
"scheduled_end_local": "",
"scheduled_start": "",
"scheduled_start_local": "",
"time_zone": ""
},
"updated_at": "",
"work_status": "",
"work_timestamps": {
"completed_at": "",
"on_my_way_at": "",
"started_at": ""
}
},
"has_more": false,
"next_cursor": null
}Get event
Get event.
Inputs
- Event id
event_idtextRequired - event_id.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"address": {
"city": "",
"state": "",
"street": "",
"street_line_2": "",
"zip": ""
},
"all_day": false,
"assigned_employees": [],
"company_id": "",
"company_name": "",
"created_at": "",
"id": "",
"name": "",
"note": "",
"recurrence_rule": "",
"schedule": {
"end_time": "",
"start_time": "",
"time_zone": ""
},
"tags": [],
"updated_at": ""
},
"has_more": false,
"next_cursor": null
}Get invoice
Get invoice.
Inputs
- Uuid
uuidtextRequired - The UUID of the invoice to retrieve
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"amount": 0,
"discounts": [],
"display_due_concept": "",
"due_amount": 0,
"due_at": "",
"due_concept": "",
"id": "",
"invoice_date": "",
"invoice_number": "",
"items": [],
"job_id": "",
"paid_at": "",
"payments": [],
"sent_at": "",
"service_date": "",
"status": "",
"subtotal": 0,
"taxes": []
},
"has_more": false,
"next_cursor": null
}Get job
Get job.
Inputs
- Id
idtextRequired - The ID of the job
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"address": {
"city": "",
"country": "",
"id": "",
"state": "",
"street": "",
"street_line_2": "",
"type": "billing",
"zip": ""
},
"assigned_employees": [],
"assigned_route_template_id": "",
"attachments": [],
"canceled_at": "",
"company_id": "",
"company_name": "",
"created_at": "",
"customer": {
"company": "",
"company_id": "",
"company_name": "",
"created_at": "",
"email": "",
"first_name": "",
"home_number": "",
"id": "",
"last_name": "",
"lead_source": "",
"mobile_number": "",
"notes": [],
"notifications_enabled": false,
"tags": [],
"updated_at": "",
"work_number": ""
},
"deleted_at": "",
"description": "",
"id": "",
"invoice_number": "",
"job_fields": {
"business_unit": {},
"job_type": {}
},
"lead_source": "",
"locked_at": "",
"notes": [],
"original_estimate_id": "",
"original_estimate_uuids": [],
"outstanding_balance": 0,
"recurrence_id": "",
"recurrence_number": 0,
"recurrence_rule": "",
"recurrence_status": "active",
"schedule": {
"appointments": [],
"arrival_window": 0,
"scheduled_end": "",
"scheduled_end_local": "",
"scheduled_start": "",
"scheduled_start_local": "",
"time_zone": ""
},
"subtotal": 0,
"tags": [],
"total_amount": 0,
"updated_at": "",
"work_status": "needs scheduling",
"work_timestamps": {
"completed_at": "",
"on_my_way_at": "",
"started_at": ""
}
},
"has_more": false,
"next_cursor": null
}Get lead
Get lead.
Inputs
- Id
idtextRequired - id.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"address": {
"city": "",
"id": "",
"state": "",
"street": "",
"street_line_2": "",
"zip": ""
},
"assigned_employee": {
"avatar_url": "",
"color_hex": "",
"company_id": "",
"company_name": "",
"created_at": "",
"email": "",
"first_name": "",
"id": "",
"last_name": "",
"mobile_number": "",
"permissions": {},
"role": "",
"tags": []
},
"company_id": "",
"company_name": "",
"conversions": [],
"customer": {
"company": "",
"email": "",
"first_name": "",
"home_number": "",
"id": "",
"last_name": "",
"lead_source": "",
"mobile_number": "",
"notifications_enabled": false,
"tags": [],
"work_number": ""
},
"id": "",
"job_fields": {
"business_unit_uuid": "",
"job_type_uuid": ""
},
"lead_source": "",
"lost_at": "",
"number": 0,
"pipeline_status": "",
"status": "lost",
"tags": [],
"total_amount": 0
},
"has_more": false,
"next_cursor": null
}List customer addresses
List customer addresses.
Inputs
- Customer id
customer_idtextRequired - customer_id.
- Page
pagenumber - Paginated page number.
- Page size
page_sizenumber - Number of addresses returned per page.
- Sort by
sort_bytext - Address attribute to sort byOne of:
created_at,updated_at. - Sort direction
sort_directiontext - Ascending or descendingOne of:
desc,asc.
Outputs
Result.
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"addresses": [],
"page": 1,
"total_pages": 1
},
"has_more": false,
"next_cursor": null
}List customers
List customers.
Inputs
- Q
qtext - A query that can be used to search for a customer by name, email, mobile number and address.
- Page
pagenumber - Current Page
- Page size
page_sizenumber - Number of customers per page
- Sort by
sort_bytext - Customer attribute to sort by
- Sort direction
sort_directiontext - Ascending or descendingOne of:
asc,desc.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"customers": [],
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
},
"has_more": false,
"next_cursor": null
}List employees
List employees.
Inputs
- Page
pagenumber - Current page
- Page size
page_sizenumber - Number of employees per page
- Sort by
sort_bytext - employee attribute to sort_by
- Sort direction
sort_directiontext - Ascending or descending
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"employees": [],
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
},
"has_more": false,
"next_cursor": null
}List estimates
List estimates.
Inputs
- Scheduled start min
scheduled_start_mindate and time - Filters estimates with a starting time greater than or equal to the date sent.
- Scheduled start max
scheduled_start_maxdate and time - Filters estimates with a starting time less than or equal to the date sent.
- Page
pagetext - Paginated page number.
- Work status
work_statuslist - Work status filter. Returns estimates from all statuses if empty.One or more of:
unscheduled,scheduled,in_progress,completed,canceled. - Page size
page_sizenumber - Number of estimates returned per page.
- Sort direction
sort_directiontext - Order of estimates returned.One of:
asc,desc. - Sort by
sort_bytext - Attribute to sort byOne of:
created_at,updated_at,id.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"estimates": [],
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
},
"has_more": false,
"next_cursor": null
}List events
List events.
Inputs
- Page
pagenumber - Paginated page number
- Page size
page_sizenumber - Number of events returned per page.
- Sort by
sort_bytext - Event attribute to sort byOne of:
name,note,created_at,updated_at,street,street_line_2,city,state,zip. - Sort direction
sort_directiontext - Ascending or descendingOne of:
asc,desc.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"events": [],
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
},
"has_more": false,
"next_cursor": null
}List invoices
List invoices.
Inputs
- Created at min
created_at_mindate and time - Filters invoices with a created_at greater than or equal to the input date
- Created at max
created_at_maxdate and time - Filters invoices with a created_at less than or equal to the input date
- Page
pagenumber - Paginated page number.At least 1.
- Page size
page_sizetext - Number of invoices returned per page.
- Sort by
sort_bytext - sort_by.One of:
amount,created_at,due_amount,due_at,invoice_number,paid_at,sent_at,status,updated_at. - Sort direction
sort_directiontext - sort_direction.One of:
asc,desc.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"invoices": [],
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
},
"has_more": false,
"next_cursor": null
}List job types
List job types.
Inputs
None.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"job_types": [],
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
},
"has_more": false,
"next_cursor": null
}List jobs
List jobs.
Inputs
- Scheduled start min
scheduled_start_mindate and time - Filters jobs with a starting time greater than or equal to the date sent.
- Scheduled start max
scheduled_start_maxdate and time - Filters jobs with a starting time less than or equal to the date sent.
- Page
pagetext - Paginated page number.
- Work status
work_statuslist - Work status filter. Returns jobs from all statuses if empty.One or more of:
unscheduled,scheduled,in_progress,completed,canceled. - Page size
page_sizenumber - Number of jobs returned per page.
- Sort direction
sort_directiontext - sort_direction.One of:
asc,desc. - Sort by
sort_bytext - Attribute to sort byOne of:
created_at,updated_at,invoice_number,id,description,work_status.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"jobs": [],
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
},
"has_more": false,
"next_cursor": null
}List lead sources
List lead sources.
Inputs
- Q
qtext - A query that can be used to search for a lead source by name
- Page
pagenumber - Current Page
- Page size
page_sizenumber - Number of lead sources per page
- Sort direction
sort_directiontext - Ascending or descendingOne of:
asc,desc.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"lead_sources": [],
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
},
"has_more": false,
"next_cursor": null
}List leads
List leads.
Inputs
- Page
pagetext - Paginated page number.
- Page size
page_sizenumber - Number of jobs returned per page.
- Sort direction
sort_directiontext - sort_direction.One of:
asc,desc. - Sort by
sort_bytext - Attribute to sort byOne of:
created_at,updated_at,id,status.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"leads": [],
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
},
"has_more": false,
"next_cursor": null
}Update customer
Update customer.
Inputs
- Customer id
customer_idtextRequired - customer_id.
- First name
first_nametext - first_name.
- Last name
last_nametext - last_name.
- Email
emailtext - email.
- Company
companytext - company.
- Notifications enabled
notifications_enabledtrue/false - Will the customer receive notifications
- Mobile number
mobile_numbertext - mobile_number.
- Home number
home_numbertext - home_number.
- Work number
work_numbertext - work_number.
- Tags
tagslist - tags.
- Lead source
lead_sourcetext - lead_source.
- Notes
notestext - notes.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"addresses": [],
"attachments": [],
"company": "",
"company_id": "",
"company_name": "",
"created_at": "",
"do_not_service": false,
"email": "",
"first_name": "",
"home_number": "",
"id": "",
"last_name": "",
"lead_source": "",
"mobile_number": "",
"notes": "",
"notifications_enabled": false,
"tags": [],
"updated_at": "",
"work_number": ""
},
"has_more": false,
"next_cursor": null
}