Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Housecall Pro

Scalekit connector
Open markdown

The Housecall Pro connector lets your AI agent act in each user's Housecall Pro account. Each user connects their own Housecall Pro API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

Tools
60
What they doRead · write · destructive
28 · 27 · 528 read27 write5 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  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.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.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)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Housecall Pro credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • housecallpro_company_getGet the company profile.Read-only

    Get Company

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

    Inputs

    This tool takes no inputs.

  • housecallpro_customer_address_getGet one of a customer's addresses.Read-only

    Get Customer Address

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

    Inputs

    address_idstringrequired
    address id. Example: adr_1f2e3d4c5b6a4987a6b5c4d3e2f1a0b9.
    customer_idstringrequired
    customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
  • housecallpro_customer_addresses_listList a customer's service and billing addresses.Read-only

    List Customer Addresses

    List a customer's service and billing addresses. Returns addresses with id, type, street, city, state, zip. Use this to pick an address_id for a job.

    Inputs

    customer_idstringrequired
    customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
    pagenumber
    Paginated page number. Example: 1.
    page_sizenumber
    Number of addresses returned per page. Example: 25.
    sort_bystring
    Address attribute to sort by. One of: created_at, updated_at. Defaults to created_at. Example: created_at.one of created_atupdated_at
    sort_directionstring
    Ascending or descending. One of: desc, asc. Defaults to desc. Example: desc.one of descasc
  • housecallpro_customer_getGet one customer.Read-only

    Get Customer

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

    Inputs

    customer_idstringrequired
    customer id. Example: cus_8c3e3f1a2b4d4e6f9a0b1c2d3e4f5a6b.
    expandarray
    Array of strings to expand response body. Example: ["attachments"]
  • housecallpro_customers_listList customers, optionally searched by name, email, phone or address.Read-only

    List Customers

    List customers, optionally searched by name, email, phone or address. Returns a page of customers (id, first_name, last_name, email, mobile_number, company, tags, addresses) plus page, page_size, total_pages and total_items. Use this to find a customer. Use housecallpro_customer_get for one.

    Inputs

    expandarray
    Array of strings to expand response body. Example: ["attachments"]
    location_idsarray
    Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
    pagenumber
    Current Page. Defaults to 1. Example: 1.
    page_sizenumber
    Number of customers per page. Defaults to 10. Example: 25.
    qstring
    A query that can be used to search for a customer by name, email, mobile number and address. Example: Smith.
    sort_bystring
    Customer attribute to sort by. Defaults to created_at. Example: created_at.
    sort_directionstring
    Ascending or descending. One of: asc, desc. Defaults to desc. Example: desc.one of ascdesc
  • housecallpro_employees_listList employees (pros).Read-only

    List Employees

    List employees (pros). Returns a page of employees (id, first_name, last_name, email, mobile_number, role, color_hex) plus page, page_size, total_pages and total_items. Use this for employee IDs to assign or dispatch.

    Inputs

    location_idsarray
    Id of locations you want to pull from. * If X-Company-Id header is set, location_ids will be ignored. Example: ["loc_1a2b3c4d5e6f"]
    pagenumber
    Current page. Defaults to 1. Example: 1.
    page_sizenumber
    Number of employees per page. Defaults to 10. Example: 25.
    sort_bystring
    employee attribute to sort_by. Defaults to created_at. Example: created_at.
    sort_directionstring
    Ascending or descending. Defaults to desc. Example: desc.
  • housecallpro_estimate_getGet one estimate.Read-only

    Get Estimate

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

    Inputs

    estimate_idstringrequired
    estimate id. Example: est_9a8b7c6d5e4f4a3b2c1d0e9f8a7b6c5d.
    expandarray
    Array of strings to expand response body. Example: ["attachments"]
  • housecallpro_estimate_option_line_items_listList the line items of an estimate option.Read-only

    List Estimate Option Line Items

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

    Inputs

    estimate_idstringrequired
    estimate id. Example: est_9a8b7c6d5e4f4a3b2c1d0e9f8a7b6c5d.
    option_idstringrequired
    option id. Example: opt_2c3d4e5f6a7b4c8d9e0f1a2b3c4d5e6f.
    pagestring
    Paginated page number. Defaults to 1. Example: 1.
    page_sizenumber
    Number of line items returned per page. Defaults to 10. Example: 25.