> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Housecall Pro

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.

**Authentication:** API Key
**Categories:** CRM & Sales, Productivity
**Tools:** 60: 28 read, 27 write, 5 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=HOUSECALLPRO)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Housecall Pro connection

   In **AgentKit > Connections**, create a Housecall Pro connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   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.actions

   const connector = 'housecallpro'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { 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 call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'housecallpro_company_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_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.actions

   connection_name = "housecallpro"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_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 call
   result = actions.execute_tool(
       tool_input={},
       tool_name="housecallpro_company_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Housecall Pro credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'housecallpro_company_get',
  toolInput: {},
  connector: 'housecallpro',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="housecallpro_company_get",
    tool_input={},
    connection_name="housecallpro",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `housecallpro_company_get`

Get Company · Read-only

Get the company profile. Returns name, phone, email, address, time zone, logo and support contact. Use this for company details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `housecallpro_customer_address_get`

Get Customer Address · Read-only

Get one of a customer's addresses. Returns the address. Use this when you know both IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `address_id` (`string`, required): address id. Example: adr_1f2e3d4c5b6a4987a6b5c4d3e2f1a0b9.
- `customer_id` (`string`, required): customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.

Example input: `{"address_id":"<address_id>","customer_id":"<customer_id>"}`

### `housecallpro_customer_addresses_list`

List Customer Addresses · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
- `page` (`number`, optional): Paginated page number. Example: 1.
- `page_size` (`number`, optional): Number of addresses returned per page. Example: 25.
- `sort_by` (`string`, optional): Address attribute to sort by. One of: created_at, updated_at. Defaults to created_at. Example: created_at. One of: `created_at`, `updated_at`.
- `sort_direction` (`string`, optional): Ascending or descending. One of: desc, asc. Defaults to desc. Example: desc. One of: `desc`, `asc`.

Example input: `{"customer_id":"<customer_id>"}`

### `housecallpro_customer_get`

Get Customer · Read-only

Get one customer. Returns the customer with contact details, tags, lead source, notes and addresses. Use this when you know the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
- `expand` (`array`, optional): Array of strings to expand response body. Example: ["attachments"]

Example input: `{"customer_id":"<customer_id>"}`

### `housecallpro_customers_list`

List Customers · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `expand` (`array`, optional): Array of strings to expand response body. Example: ["attachments"]
- `location_ids` (`array`, optional): Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
- `page` (`number`, optional): Current Page. Defaults to 1. Example: 1.
- `page_size` (`number`, optional): Number of customers per page. Defaults to 10. Example: 25.
- `q` (`string`, optional): A query that can be used to search for a customer by name, email, mobile number and address. Example: Smith.
- `sort_by` (`string`, optional): Customer attribute to sort by. Defaults to created_at. Example: created_at.
- `sort_direction` (`string`, optional): Ascending or descending. One of: asc, desc. Defaults to desc. Example: desc. One of: `asc`, `desc`.

Example input: `{}`

### `housecallpro_employees_list`

List Employees · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `location_ids` (`array`, optional): Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
- `page` (`number`, optional): Current page. Defaults to 1. Example: 1.
- `page_size` (`number`, optional): Number of employees per page. Defaults to 10. Example: 25.
- `sort_by` (`string`, optional): employee attribute to sort_by. Defaults to created_at. Example: created_at.
- `sort_direction` (`string`, optional): Ascending or descending. Defaults to desc. Example: desc.

Example input: `{}`

### `housecallpro_estimate_get`

Get Estimate · Read-only

Get one estimate. Returns the estimate with customer, address, schedule and options (with status and total). Use this when you know the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `estimate_id` (`string`, required): estimate id. Example: est_9a8b7c6d5e4f4a3b2c1d0e9f8a7b6c5d.
- `expand` (`array`, optional): Array of strings to expand response body. Example: ["attachments"]

Example input: `{"estimate_id":"<estimate_id>"}`

### `housecallpro_estimate_option_line_items_list`

List Estimate Option Line Items · Read-only

List the line items of an estimate option. Returns line items with name, unit_price, quantity and amount. Use this to review an option.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `estimate_id` (`string`, required): estimate id. Example: est_9a8b7c6d5e4f4a3b2c1d0e9f8a7b6c5d.
- `option_id` (`string`, required): option id. Example: opt_2c3d4e5f6a7b4c8d9e0f1a2b3c4d5e6f.
- `page` (`string`, optional): Paginated page number. Defaults to 1. Example: 1.
- `page_size` (`number`, optional): Number of line items returned per page. Defaults to 10. Example: 25.

Example input: `{"estimate_id":"<estimate_id>","option_id":"<option_id>"}`

### `housecallpro_estimates_list`

List Estimates · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, optional): Filters estimates by a single customer ID (string). Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
- `employee_ids` (`array`, optional): Filters estimates by assigned pro id. Example: ["pro_5c6d7e8f9a0b"]
- `expand` (`array`, optional): Array of strings to expand response body. Example: ["attachments"]
- `location_ids` (`array`, optional): Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
- `page` (`string`, optional): Paginated page number. Defaults to 1. Example: 1.
- `page_size` (`number`, optional): Number of estimates returned per page. Defaults to 10. Example: 25.
- `scheduled_end_max` (`string`, optional): Filters estimates with an end time less than or equal to the date sent. Example: 2026-01-31T23:59:59Z.
- `scheduled_end_min` (`string`, optional): Filters estimates with an end time greater than or equal to the date sent. Example: 2026-01-01T00:00:00Z.
- `scheduled_start_max` (`string`, optional): Filters estimates with a starting time less than or equal to the date sent. Example: 2026-01-31T23:59:59Z.
- `scheduled_start_min` (`string`, optional): Filters estimates with a starting time greater than or equal to the date sent. Example: 2026-01-01T00:00:00Z.
- `sort_by` (`string`, optional): Attribute to sort by. One of: created_at, updated_at, id. Defaults to created_at. Example: created_at. One of: `created_at`, `updated_at`, `id`.
- `sort_direction` (`string`, optional): Order of estimates returned. One of: asc, desc. Defaults to desc. Example: desc. One of: `asc`, `desc`.
- `work_status` (`array`, optional): Work status filter. Returns estimates from all statuses if empty. Example: ["scheduled"]

Example input: `{}`

### `housecallpro_event_get`

Get Event · Read-only

Get one event. Returns the event with name, schedule and employees. Use this when you know the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `event_id` (`string`, required): event id. Example: evt_6f5e4d3c2b1a4f0e9d8c7b6a5f4e3d2c.

Example input: `{"event_id":"<event_id>"}`

### `housecallpro_events_list`

List Events · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `location_ids` (`array`, optional): Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
- `page` (`number`, optional): Paginated page number. Example: 1.
- `page_size` (`number`, optional): Number of events returned per page. Example: 25.
- `sort_by` (`string`, optional): 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: `name`, `note`, `created_at`, `updated_at`, `street`, `street_line_2`, `city`, `state`, `zip`.
- `sort_direction` (`string`, optional): Ascending or descending. One of: asc, desc. Defaults to desc. Example: desc. One of: `asc`, `desc`.

Example input: `{}`

### `housecallpro_invoice_get`

Get Invoice · Read-only

Get one invoice by UUID. Returns the invoice with line items, taxes, discounts, payments and balances. Use this when you know the invoice UUID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uuid` (`string`, required): The UUID of the invoice to retrieve. Example: inv_7e6d5c4b3a2f4e1d0c9b8a7f6e5d4c3b.

Example input: `{"uuid":"<uuid>"}`

### `housecallpro_invoices_list`

List Invoices · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `amount_due_max` (`number`, optional): Filters invoices with an amount_due less than or equal to the input amount. Example: 10.
- `amount_due_min` (`number`, optional): Filters invoices with an amount_due greater than or equal to the input amount. Example: 10.
- `created_at_max` (`string`, optional): Filters invoices with a created_at less than or equal to the input date. Example: 2024-01-30T00:00:00Z.
- `created_at_min` (`string`, optional): Filters invoices with a created_at greater than or equal to the input date. Example: 2024-01-30T00:00:00Z.
- `customer_uuid` (`array`, optional): Filters invoices by customer UUIDs. Example: cus_123.
- `due_at_max` (`string`, optional): Filters invoices with a due_at less than or equal to the input date. Example: 2024-01-30T00:00:00Z.
- `due_at_min` (`string`, optional): Filters invoices with a due_at greater than or equal to the input date. Example: 2024-01-30T00:00:00Z.
- `location_ids` (`array`, optional): Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
- `page` (`integer`, optional): Paginated page number. Defaults to 1. Example: 1.
- `page_size` (`string`, optional): Number of invoices returned per page. Defaults to 10. Example: 25.
- `paid_at_max` (`string`, optional): Filters invoices with a paid_at less than or equal to the input date. Example: 2024-01-30T00:00:00Z.
- `paid_at_min` (`string`, optional): Filters invoices with a paid_at greater than or equal to the input date. Example: 2024-01-30T00:00:00Z.
- `payment_method` (`array`, optional): Filters invoices by payment_method. Example: credit_card.
- `sort_by` (`string`, optional): 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: `amount`, `created_at`, `due_amount`, `due_at`, `invoice_number`, `paid_at`, `sent_at`, `status`, `updated_at`.
- `sort_direction` (`string`, optional): sort direction. One of: asc, desc. Defaults to desc. Example: desc. One of: `asc`, `desc`.
- `status` (`array`, optional): Filters invoices by status. Example: open.

Example input: `{}`

### `housecallpro_job_appointments_list`

List Job Appointments · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.

Example input: `{"job_id":"<job_id>"}`

### `housecallpro_job_get`

Get Job · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): The ID of the job. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
- `expand` (`array`, optional): Array of strings to expand response body. Example: ["attachments"]

Example input: `{"id":"<id>"}`

### `housecallpro_job_invoices_list`

List Job Invoices · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.

Example input: `{"job_id":"<job_id>"}`

### `housecallpro_job_line_items_list`

List Job Line Items · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.

Example input: `{"job_id":"<job_id>"}`

### `housecallpro_job_types_list`

List Job Types · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, optional): filter job types by name. Example: sk-test item.

Example input: `{}`

### `housecallpro_jobs_list`

List Jobs · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, optional): Filters jobs by a single customer ID (string). Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
- `employee_ids` (`array`, optional): employee ids. Example: ["pro_5c6d7e8f9a0b"]
- `expand` (`array`, optional): Array of strings to expand response body. Example: ["attachments"]
- `location_ids` (`array`, optional): Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
- `page` (`string`, optional): Paginated page number. Defaults to 1. Example: 1.
- `page_size` (`number`, optional): Number of jobs returned per page. Defaults to 10. Example: 25.
- `scheduled_end_max` (`string`, optional): Filters jobs with an end time less than or equal to the date sent. Example: 2026-01-31T23:59:59Z.
- `scheduled_end_min` (`string`, optional): Filters jobs with an end time greater than or equal to the date sent. Example: 2026-01-01T00:00:00Z.
- `scheduled_start_max` (`string`, optional): Filters jobs with a starting time less than or equal to the date sent. Example: 2026-01-31T23:59:59Z.
- `scheduled_start_min` (`string`, optional): Filters jobs with a starting time greater than or equal to the date sent. Example: 2026-01-01T00:00:00Z.
- `sort_by` (`string`, optional): 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_at`, `updated_at`, `invoice_number`, `id`, `description`, `work_status`.
- `sort_direction` (`string`, optional): sort direction. One of: asc, desc. Defaults to desc. Example: desc. One of: `asc`, `desc`.
- `work_status` (`array`, optional): Work status filter. Returns jobs from all statuses if empty. Example: ["scheduled"]

Example input: `{}`

### `housecallpro_lead_get`

Get Lead · Read-only

Get one lead. Returns the lead with customer, address, line items, notes and status. Use this when you know the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): id. Example: lead_3c4d5e6f7a8b4c9d0e1f2a3b4c5d6e7f.

Example input: `{"id":"<id>"}`

### `housecallpro_lead_sources_list`

List Lead Sources · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`number`, optional): Current Page. Defaults to 1. Example: 1.
- `page_size` (`number`, optional): Number of lead sources per page. Defaults to 10. Example: 25.
- `q` (`string`, optional): A query that can be used to search for a lead source by name. Example: Smith.
- `sort_direction` (`string`, optional): Ascending or descending. One of: asc, desc. Defaults to desc. Example: desc. One of: `asc`, `desc`.

Example input: `{}`

### `housecallpro_leads_list`

List Leads · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, optional): Filters leads by a single customer ID (string). Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
- `employee_ids` (`array`, optional): Filters leads by a list of employee IDs (string). Example: ["pro_5c6d7e8f9a0b"]
- `lead_source` (`array`, optional): Filters leads by a single lead_source. Example: Google.
- `location_ids` (`array`, optional): Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
- `page` (`string`, optional): Paginated page number. Defaults to 1. Example: 1.
- `page_size` (`number`, optional): Number of jobs returned per page. Defaults to 10. Example: 25.
- `sort_by` (`string`, optional): Attribute to sort by. One of: created_at, updated_at, id, status. Defaults to created_at. Example: created_at. One of: `created_at`, `updated_at`, `id`, `status`.
- `sort_direction` (`string`, optional): sort direction. One of: asc, desc. Defaults to desc. Example: desc. One of: `asc`, `desc`.
- `status` (`string`, optional): Filters leads by status. One of: lost, open, won. Example: lost. One of: `lost`, `open`, `won`.
- `tag_ids` (`array`, optional): Filters leads by a list of tags. Example: ["tag_3e4f5a6b7c8d4e9f0a1b2c3d4e5f6a7b"]

Example input: `{}`

### `housecallpro_materials_list`

List Price Book Materials · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `material_category_uuid` (`string`, required): UUID of the material category to fetch materials under. Example: pbmcat_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6.
- `page` (`number`, optional): Paginated page number. Defaults to 1. Example: 1.
- `page_size` (`number`, optional): Number of materials returned per page. Defaults to 10. Example: 25.
- `sort_by` (`string`, optional): Material attribute to sort by. One of: name, updated_at, created_at. Defaults to created_at. Example: created_at. One of: `name`, `updated_at`, `created_at`.
- `sort_direction` (`string`, optional): Ascending or descending. One of: asc, desc. Defaults to desc. Example: desc. One of: `asc`, `desc`.

Example input: `{"material_category_uuid":"<material_category_uuid>"}`

### `housecallpro_pipeline_statuses_list`

List Pipeline Statuses · Read-only

List sales pipeline statuses for leads, estimates or jobs. Returns statuses with id, name and resource type. Use this before housecallpro_pipeline_status_update.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `resource_type` (`string`, required): resource type. One of: lead, job, estimate. Example: job. One of: `lead`, `job`, `estimate`.
- `page` (`integer`, optional): page. Defaults to 1. Example: 1.
- `page_size` (`integer`, optional): page size. Defaults to 10. Example: 25.

Example input: `{"resource_type":"lead"}`

### `housecallpro_price_book_services_list`

List Price Book Services · Read-only

List price book services. Returns services with uuid, name, price, category and duration. Use this to find services to bill.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `expand` (`array`, optional): 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_operator` (`string`, optional): Filter operator (sent as filters[][operator]); only eq is supported. Example: eq. One of: `eq`.
- `filter_property` (`string`, optional): Filter on one property (sent as filters[][property]); use with filter_value. Example: online_booking_enabled. One of: `online_booking_enabled`, `managed_by`, `flat_rate_enabled`, `taxable`, `category`, `organization_industry`.
- `filter_value` (`string`, optional): Filter value (sent as filters[][values][]), e.g. true or a category name. Example: true.
- `page` (`number`, optional): Current Page. Defaults to 1. Example: 1.
- `page_size` (`number`, optional): Number of items returned per page. Defaults to 10. Example: 25.
- `q` (`string`, optional): A query that can be used to search for a service by name, description and task_number. Example: Smith.
- `sort_by` (`string`, optional): Price book service attribute to sort by. Defaults to created_at. Example: created_at.
- `sort_direction` (`string`, optional): Ascending or descending. One of: asc, desc. Defaults to desc. Example: desc. One of: `asc`, `desc`.

Example input: `{}`

### `housecallpro_schedule_availability_get`

Get Schedule Availability · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `housecallpro_service_zones_list`

List Service Zones · Read-only

List service zones (areas the company serves). Returns zones with id, name and postal codes. Use this to check coverage.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `address` (`string`, optional): Filter service zones by address. Example: {"street": "123 Main St", "city": "San Francisco", "state": "CA", "zip": "94105"}
- `page` (`number`, optional): Current Page. Defaults to 1. Example: 1.
- `page_size` (`number`, optional): Number of service zones per page. Defaults to 10. Example: 25.
- `zip_code` (`string`, optional): Filter service zones by zip code. Example: 94105.

Example input: `{}`

### `housecallpro_tags_list`

List Tags · Read-only

List tags. Returns a page of tags (id, name, color) plus page, page_size, total_pages and total_items. Use this for tag IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`number`, optional): Current Page. Defaults to 1. Example: 1.
- `page_size` (`number`, optional): Number of tags per page. Defaults to 10. Example: 25.
- `sort_by` (`string`, optional): Tag attribute to sort by. One of: created_at, name. Defaults to created_at. Example: created_at. One of: `created_at`, `name`.
- `sort_direction` (`string`, optional): sort direction. One of: asc, desc. Defaults to desc. Example: desc. One of: `asc`, `desc`.

Example input: `{}`

### `housecallpro_customer_address_create`

Create Customer Address · Write

Add an address to a customer. Returns the created address. Use this before creating a job at a new address.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `city` (`string`, required): city. Example: San Francisco.
- `country` (`string`, required): country. Example: US.
- `customer_id` (`string`, required): customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
- `state` (`string`, required): state. Example: CA.
- `street` (`string`, required): street. Example: 500 Market St.
- `zip` (`string`, required): zip. Example: 94105.
- `latitude` (`number`, optional): latitude. Example: 1.
- `longitude` (`number`, optional): longitude. Example: 1.
- `street_line_2` (`string`, optional): street line 2. Example: Suite 2.

Example input: `{"city":"<city>","country":"<country>","customer_id":"<customer_id>","state":"<state>","street":"<street>","zip":"<zip>"}`

### `housecallpro_customer_create`

Create Customer · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `addresses` (`array`, optional): addresses. Example: [{"street": "123 Main St", "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US"}]
- `company` (`string`, optional): company. Example: Doe Plumbing.
- `email` (`string`, optional): email. Example: jane.doe@example.com.
- `first_name` (`string`, optional): first name. Example: Jane.
- `home_number` (`string`, optional): home number. Example: 4155550101.
- `last_name` (`string`, optional): last name. Example: Doe.
- `lead_source` (`string`, optional): lead source. Example: Google.
- `mobile_number` (`string`, optional): mobile number. Example: 4155550100.
- `notes` (`string`, optional): notes. Example: Gate code 1234.
- `notifications_enabled` (`boolean`, optional): Will the customer receive notifications. Example: true.
- `tags` (`array`, optional): tags. Example: ["VIP"]
- `work_number` (`string`, optional): work number. Example: 4155550102.

Example input: `{}`

### `housecallpro_customer_update`

Update Customer · Write

Update a customer's contact details, tags, lead source or notes. Returns the updated customer. Use housecallpro_customer_address_create to add an address.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
- `company` (`string`, optional): company. Example: Doe Plumbing.
- `email` (`string`, optional): email. Example: jane.doe@example.com.
- `first_name` (`string`, optional): first name. Example: Jane.
- `home_number` (`string`, optional): home number. Example: 4155550101.
- `last_name` (`string`, optional): last name. Example: Doe.
- `lead_source` (`string`, optional): lead source. Example: Google.
- `mobile_number` (`string`, optional): mobile number. Example: 4155550100.
- `notes` (`string`, optional): notes. Example: Gate code 1234.
- `notifications_enabled` (`boolean`, optional): Will the customer receive notifications. Example: true.
- `tags` (`array`, optional): tags. Example: ["VIP"]
- `work_number` (`string`, optional): work number. Example: 4155550102.

Example input: `{"customer_id":"<customer_id>"}`

### `housecallpro_estimate_create`

Create Estimate · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `address` (`object`, optional): address. Example: {"street": "123 Main St", "city": "San Francisco", "state": "CA", "zip": "94105"}
- `address_id` (`string`, optional): address id. Example: adr_1f2e3d4c5b6a4987a6b5c4d3e2f1a0b9.
- `assigned_employee_ids` (`array`, optional): assigned employee ids. Example: ["pro_5c6d7e8f9a0b"]
- `customer_id` (`string`, optional): customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
- `estimate_fields` (`object`, optional): estimate fields. Example: {"job_type_id": "jt_1b2c3d4e5f6a47b8c9d0e1f2a3b4c5d6"}
- `estimate_number` (`integer`, optional): Estimate number unique across all of a company's estimates in Housecall Pro. If left blank, one will be automatically generated. Example: 2001.
- `lead_source` (`string`, optional): lead source. Example: Google.
- `message` (`string`, optional): message. Example: Thanks for the opportunity!.
- `note` (`string`, optional): note. Example: Customer prefers mornings.
- `options` (`array`, optional): options. Example: [{"name": "Option A", "line_items": [{"name": "Install", "unit_price": 50000, "quantity": 1}]}]
- `schedule` (`object`, optional): schedule. Example: {"scheduled_start": "2026-01-15T16:00:00Z", "scheduled_end": "2026-01-15T18:00:00Z", "arrival_window": 60}
- `tax` (`object`, optional): tax. Example: {"name": "Sales tax", "rate": 8.5}

Example input: `{}`

### `housecallpro_estimate_option_create`

Create Estimate Option · Write

Add an option (an alternative quote) with line items to an estimate. Returns the created option. Use this to offer good/better/best options.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `estimate_id` (`string`, required): The UUID of the estimate. Example: est_9a8b7c6d5e4f4a3b2c1d0e9f8a7b6c5d.
- `name` (`string`, required): Name of the estimate option. Example: sk-test item.
- `line_items` (`array`, optional): Line items to add to the option. Example: [{"name": "Water heater flush", "unit_price": 15000, "quantity": 1}]
- `tax` (`object`, optional): Tax settings for the option. When taxable is true, both tax_name and tax_rate are required. Example: {"name": "Sales tax", "rate": 8.5}

Example input: `{"estimate_id":"<estimate_id>","name":"<name>"}`

### `housecallpro_estimate_option_note_add`

Add Estimate Option Note · Write

Add a note to an estimate option. Returns the created note. Use this to record context on an option.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `content` (`string`, required): content. Example: Arrived on time, replaced valve.
- `estimate_id` (`string`, required): estimate id. Example: est_9a8b7c6d5e4f4a3b2c1d0e9f8a7b6c5d.
- `option_id` (`string`, required): option id. Example: opt_2c3d4e5f6a7b4c8d9e0f1a2b3c4d5e6f.

Example input: `{"content":"<content>","estimate_id":"<estimate_id>","option_id":"<option_id>"}`

### `housecallpro_estimate_options_approve`

Approve Estimate Options · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `option_ids` (`array`, required): option ids. Example: ["opt_2c3d4e5f6a7b4c8d9e0f1a2b3c4d5e6f"]

Example input: `{"option_ids":["opt_2c3d4e5f6a7b4c8d9e0f1a2b3c4d5e6f"]}`

### `housecallpro_estimate_options_decline`

Decline Estimate Options · Write

Mark estimate options as declined. Returns the declined options. Use this when the customer rejects a quote.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `option_ids` (`array`, required): option ids. Example: ["opt_2c3d4e5f6a7b4c8d9e0f1a2b3c4d5e6f"]

Example input: `{"option_ids":["opt_2c3d4e5f6a7b4c8d9e0f1a2b3c4d5e6f"]}`

### `housecallpro_job_appointment_create`

Create Job Appointment · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `dispatched_employees_ids` (`array`, required): List of pros ids to be assign in appointment. Example: ["pro_5c6d7e8f9a0b"]
- `end_time` (`string`, required): End time of job appointment in iso8601. Example: 2026-01-15T18:00:00Z.
- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
- `start_time` (`string`, required): Start time of job appointment in iso8601. Example: 2026-01-15T16:00:00Z.
- `arrival_window_minutes` (`integer`, optional): Integer value in minutes of arrival window. Example: 60.

Example input: `{"dispatched_employees_ids":["pro_5c6d7e8f9a0b"],"end_time":"<end_time>","job_id":"<job_id>","start_time":"<start_time>"}`

### `housecallpro_job_appointment_update`

Update Job Appointment · Write

Reschedule an appointment or change its employees. Returns the updated appointment. Use this to move a visit.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `appointment_id` (`string`, required): appointment id. Example: apt_5e6f7a8b9c0d4e1f2a3b4c5d6e7f8a9b.
- `dispatched_employees_ids` (`array`, required): List of pros ids to be assign in appointment. Example: ["pro_5c6d7e8f9a0b"]
- `end_time` (`string`, required): End time of job appointment in iso8601. Example: 2026-01-15T18:00:00Z.
- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
- `start_time` (`string`, required): Start time of job appointment in iso8601. Example: 2026-01-15T16:00:00Z.
- `arrival_window_minutes` (`integer`, optional): Integer value in minutes of arrival window. Example: 60.

Example input: `{"appointment_id":"<appointment_id>","dispatched_employees_ids":["pro_5c6d7e8f9a0b"],"end_time":"<end_time>","job_id":"<job_id>","start_time":"<start_time>"}`

### `housecallpro_job_create`

Create Job · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `address_id` (`string`, required): address id. Example: adr_1f2e3d4c5b6a4987a6b5c4d3e2f1a0b9.
- `customer_id` (`string`, required): customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
- `assigned_employee_ids` (`array`, optional): assigned employee ids. Example: ["pro_5c6d7e8f9a0b"]
- `invoice_number` (`number`, optional): 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_fields` (`object`, optional): job fields. Example: {"job_type_id": "jt_1b2c3d4e5f6a47b8c9d0e1f2a3b4c5d6"}
- `lead_source` (`string`, optional): lead source. Example: Google.
- `line_items` (`array`, optional): line items. Example: [{"name": "Water heater flush", "unit_price": 15000, "quantity": 1}]
- `notes` (`string`, optional): notes. Example: Gate code 1234.
- `schedule` (`object`, optional): schedule. Example: {"scheduled_start": "2026-01-15T16:00:00Z", "scheduled_end": "2026-01-15T18:00:00Z", "arrival_window": 60}
- `tags` (`array`, optional): tags. Example: ["VIP"]

Example input: `{"address_id":"<address_id>","customer_id":"<customer_id>"}`

### `housecallpro_job_dispatch`

Dispatch Job · Write

Dispatch a job to employees, replacing the current assignment. Returns the updated dispatch list. Use this to assign technicians.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `dispatched_employees` (`array`, required): dispatched employees. Example: ["pro_5c6d7e8f9a0b"]
- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.

Example input: `{"dispatched_employees":["pro_5c6d7e8f9a0b"],"job_id":"<job_id>"}`

### `housecallpro_job_line_item_add`

Add Job Line Item · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
- `name` (`string`, required): name. Example: sk-test item.
- `description` (`string`, optional): description. Example: Flush and inspect tank.
- `kind` (`string`, optional): kind. One of: materials, labor, fixed gratuity, fixed discount, percent discount. Example: labor. One of: `materials`, `labor`, `fixed gratuity`, `fixed discount`, `percent discount`.
- `quantity` (`number`, optional): The number of items being solid. This can be a float up to two decmial places. Example: 1.
- `service_item_id` (`string`, optional): ID of the service item this line item is based on, if applicable. Example: pbsvc_1a2b3c4d5e6f.
- `service_item_type` (`string`, optional): service item type. One of: market_place, organizational, pricebook_material. Example: pricebook_material. One of: `market_place`, `organizational`, `pricebook_material`.
- `taxable` (`boolean`, optional): taxable. Example: true.
- `unit_cost` (`number`, optional): Direct cost to the company of a singe unit in cents. This value is used for job costing. Example: 5000.
- `unit_price` (`number`, optional): Selling price of a singe unit in cents. Example: 15000.

Example input: `{"job_id":"<job_id>","name":"<name>"}`

### `housecallpro_job_line_item_update`

Update Job Line Item · Write

Update one line item on a job. Returns the updated line item. Use this to change price or quantity.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): id. Example: li_9a8b7c6d5e4f.
- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
- `name` (`string`, required): name. Example: sk-test item.
- `description` (`string`, optional): description. Example: Flush and inspect tank.
- `kind` (`string`, optional): kind. One of: materials, labor, fixed gratuity, fixed discount, percent discount. Example: labor. One of: `materials`, `labor`, `fixed gratuity`, `fixed discount`, `percent discount`.
- `quantity` (`number`, optional): quantity. Example: 1.
- `service_item_id` (`string`, optional): service item id. Example: pbsvc_1a2b3c4d5e6f.
- `service_item_type` (`string`, optional): service item type. One of: market_place, organizational, pricebook_material. Example: pricebook_material. One of: `market_place`, `organizational`, `pricebook_material`.
- `taxable` (`boolean`, optional): taxable. Example: true.
- `unit_cost` (`number`, optional): unit cost. Example: 5000.
- `unit_price` (`number`, optional): unit price. Example: 15000.

Example input: `{"id":"<id>","job_id":"<job_id>","name":"<name>"}`

### `housecallpro_job_note_add`

Add Job Note · Write

Add a private note to a job. Returns the created note. Use this to record context on a job.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `content` (`string`, required): content. Example: Arrived on time, replaced valve.
- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.

Example input: `{"content":"<content>","job_id":"<job_id>"}`

### `housecallpro_job_schedule_update`

Update Job Schedule · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
- `start_time` (`string`, required): Start time of job in iso8601. Example: 2026-01-15T16:00:00Z.
- `arrival_window_in_minutes` (`number`, optional): Integer value in minutes of arrival window. Example: 60.
- `dispatched_employees` (`array`, optional): dispatched employees. Example: ["pro_5c6d7e8f9a0b"]
- `end_time` (`string`, optional): End time of job in iso8601. Example: 2026-01-15T18:00:00Z.
- `expand` (`array`, optional): expand. Example: ["attachments"]
- `notify` (`boolean`, optional): Notify the customer of the update schedule. Example: true.
- `notify_pro` (`boolean`, optional): Notify the employee of the update schedule. Example: true.

Example input: `{"job_id":"<job_id>","start_time":"<start_time>"}`

### `housecallpro_job_tag_add`

Add Job Tag · Write

Add an existing tag to a job. Returns the job's tags. Use housecallpro_tags_list for tag IDs.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
- `tag_id` (`string`, required): tag id. Example: tag_3e4f5a6b7c8d4e9f0a1b2c3d4e5f6a7b.

Example input: `{"job_id":"<job_id>","tag_id":"<tag_id>"}`

### `housecallpro_job_type_create`

Create Job Type · Write

Create a job type. Returns the created job type. Use this to categorize jobs.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): name. Example: sk-test maintenance.

Example input: `{"name":"<name>"}`

### `housecallpro_job_type_update`

Update Job Type · Write

Rename a job type. Returns the updated job type. Use this to change a job type.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `job_type_id` (`string`, required): job type id. Example: jt_1b2c3d4e5f6a47b8c9d0e1f2a3b4c5d6.
- `name` (`string`, required): name. Example: sk-test annual maintenance.

Example input: `{"job_type_id":"<job_type_id>","name":"<name>"}`

### `housecallpro_lead_convert`

Convert Lead · Write

Convert a lead into an estimate or a job. Returns the created estimate or job. Use this once the lead is qualified.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): id. Example: lead_3c4d5e6f7a8b4c9d0e1f2a3b4c5d6e7f.
- `type` (`string`, optional): The type to convert the lead to. Must be either "estimate" or "job". One of: estimate, job. Example: job. One of: `estimate`, `job`.

Example input: `{"id":"<id>"}`

### `housecallpro_lead_create`

Create Lead · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `address` (`object`, optional): address. Example: {"street": "123 Main St", "city": "San Francisco", "state": "CA", "zip": "94105"}
- `address_id` (`string`, optional): address id. Example: adr_1f2e3d4c5b6a4987a6b5c4d3e2f1a0b9.
- `assigned_employee_id` (`string`, optional): assigned employee id. Example: pro_5c6d7e8f9a0b.
- `customer` (`object`, optional): Either this or Customer ID required. Example: {"first_name": "Jane", "last_name": "Doe", "email": "jane.doe@example.com"}
- `customer_id` (`string`, optional): Either this or Customer required. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
- `lead_source` (`string`, optional): lead source. Example: Google.
- `line_items` (`array`, optional): line items. Example: [{"name": "Water heater flush", "unit_price": 15000, "quantity": 1}]
- `note` (`string`, optional): note. Example: Customer prefers mornings.
- `tags` (`array`, optional): tags. Example: ["VIP"]
- `tax_name` (`string`, optional): tax name. Example: Sales tax.
- `tax_rate` (`integer`, optional): tax rate. Example: 8.

Example input: `{}`

### `housecallpro_lead_source_create`

Create Lead Source · Write

Create a lead source. Returns the created lead source. Use this to track a new marketing channel.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): name. Example: sk-test referral.

Example input: `{"name":"<name>"}`

### `housecallpro_lead_source_update`

Update Lead Source · Write

Rename a lead source. Returns the updated lead source. Use this to fix a name.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `lead_source_id` (`string`, required): lead source id. Example: ls_0a1b2c3d4e5f46a7b8c9d0e1f2a3b4c5.
- `name` (`string`, optional): name. Example: sk-test referral program.

Example input: `{"lead_source_id":"<lead_source_id>"}`

### `housecallpro_material_create`

Create Price Book Material · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `cost` (`integer`, required): cost of the material to be created in cents. Example: 5000.
- `material_category_uuid` (`string`, required): UUID of the material category to create this material under. Example: pbmcat_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6.
- `material_category_uuid_body` (`string`, required): UUID of the material category to create this material under. Example: pbmcat_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6.
- `name` (`string`, required): name of the material to be created. Example: sk-test valve.
- `price` (`integer`, required): price of the material to be created in cents. Example: 15000.
- `description` (`string`, optional): description of the material to be created. Example: Flush and inspect tank.
- `flat_rate_enabled` (`boolean`, optional): flat rate enabled. Example: true.
- `part_number` (`string`, optional): part number of the material to be created. Example: WH-VALVE-01.
- `taxable` (`boolean`, optional): if the material should be taxable on invoice. Example: true.
- `unit_of_measure` (`string`, optional): unit of measure of the material to be created (i.e. each). Example: each.

Example input: `{"cost":5000,"material_category_uuid":"<material_category_uuid>","material_category_uuid_body":"<material_category_uuid_body>","name":"<name>","price":15000}`

### `housecallpro_pipeline_status_update`

Update Pipeline Status · Write

Move a lead, estimate or job to a pipeline status. Returns the updated resource status. Use this to advance a deal through the pipeline.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `resource_id` (`string`, required): the UUID of the resource. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
- `resource_type` (`string`, required): resource type. One of: lead, job, estimate. Example: job. One of: `lead`, `job`, `estimate`.
- `status_id` (`string`, required): the UUID of the pipeline status. Example: pst_1a2b3c4d5e6f.

Example input: `{"resource_id":"<resource_id>","resource_type":"lead","status_id":"<status_id>"}`

### `housecallpro_tag_create`

Create Tag · Write

Create a tag. Returns the created tag. Use this before tagging jobs or customers.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, optional): name. Example: sk-test VIP.

Example input: `{}`

### `housecallpro_tag_update`

Update Tag · Write

Rename or recolor a tag. Returns the updated tag. Use this to change a tag.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `tag_id` (`string`, required): tag id. Example: tag_3e4f5a6b7c8d4e9f0a1b2c3d4e5f6a7b.
- `name` (`string`, optional): name. Example: sk-test VIP customer.

Example input: `{"tag_id":"<tag_id>"}`

### `housecallpro_job_appointment_delete`

Delete Job Appointment · Destructive

Delete an appointment from a job. Returns an empty response on success. Use this to cancel one visit.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `appointment_id` (`string`, required): appointment id. Example: apt_5e6f7a8b9c0d4e1f2a3b4c5d6e7f8a9b.
- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.

Example input: `{"appointment_id":"<appointment_id>","job_id":"<job_id>"}`

### `housecallpro_job_line_item_delete`

Delete Job Line Item · Destructive

Delete one line item from a job. Returns an empty response on success. Use this to remove a charge.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): id. Example: li_9a8b7c6d5e4f.
- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.

Example input: `{"id":"<id>","job_id":"<job_id>"}`

### `housecallpro_job_note_delete`

Delete Job Note · Destructive

Delete a note from a job. Returns an empty response on success. Use this to remove a note.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
- `note_id` (`string`, required): note id. Example: nte_7a6b5c4d3e2f4a1b0c9d8e7f6a5b4c3d.

Example input: `{"job_id":"<job_id>","note_id":"<note_id>"}`

### `housecallpro_job_tag_remove`

Remove Job Tag · Destructive

Remove a tag from a job. Returns an empty response on success. Use this to untag a job.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `job_id` (`string`, required): job id. Example: job_4b8a9c2d1e3f4a5b6c7d8e9f0a1b2c3d.
- `tag_id` (`string`, required): tag id. Example: tag_3e4f5a6b7c8d4e9f0a1b2c3d4e5f6a7b.

Example input: `{"job_id":"<job_id>","tag_id":"<tag_id>"}`

### `housecallpro_material_delete`

Delete Price Book Material · Destructive

Delete a price book material. Returns an empty response on success. Use this to retire a part.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `uuid` (`string`, required): UUID of the material to be updated. Example: pbmat_8f7e6d5c4b3a4f2e1d0c9b8a7f6e5d4c.

Example input: `{"uuid":"<uuid>"}`

## Related

Other CRM & Sales connectors ([all 174](/agentkit/connectors/?category=crm-sales)):

- [Salesforce](/agentkit/connectors/salesforce/): Scalekit connector, OAuth, 74 tools
- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Close](/agentkit/connectors/close/): Scalekit connector, OAuth, 103 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
