Housecall Pro API
15 endpoints for Housecall Pro, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.
- Base URL
- https://cotlet.dev/api/v1/housecall-pro
- Connects with
- Your own Housecall Pro account (office or admin role for invoices and payments)
- Integration page
- Housecall Pro
Read (7)
Return data and change nothing in the account.
| Endpoint | Description |
|---|---|
| GET | Search customers by name, email, phone or address, with their service addresses. |
| GET | Jobs with customer, schedule, assigned team and total, newest first. |
| GET | One job with line items, total, notes, schedule and every invoice on it. |
| GET | Estimates with their options, totals and status such as Customer Approved or Customer Declined. |
| GET | Invoices with status, amount due, due date and last send date, filtered like the Invoice list. |
| GET | One invoice with line items, amount due, payment history and send history. |
| GET | Services and materials from your Price book with their prices. |
Write (8)
Change the account. Calls marked Confirm wait for the user to approve them.
| Endpoint | Description |
|---|---|
| POST | Add a customer with a name, contact details and a service address. |
| POST | Create a job for a customer with line items and, optionally, a schedule and a dispatched team member. |
| POST | Create a draft estimate for a customer with a first option and its line items. |
| POST | Add a named option with its own line items to a draft estimate. |
| POST | Send an estimate with chosen options to the customer by email or text. |
| POST | Create an invoice for a percent or a fixed amount of a job total. Needs Progressive invoicing on the account. |
| POST | Send or resend an invoice to the customer by email or text with a message. |
| POST | Apply a payment to an open invoice, optionally sending the customer a receipt. |