Housecall Pro

Interact with the Housecall Pro API

Overview

This node integrates with the Housecall Pro API to manage various resources related to service businesses, such as applications, customers, jobs, invoices, and more. Specifically, for the Application resource with the Get All Addresses operation (which is actually under the "customers" resource in the code), it retrieves all addresses associated with a particular customer.

A common use case for this operation is when you need to fetch all saved addresses of a customer to display them, verify them, or use them for scheduling jobs or deliveries. For example, a service company might want to pull all customer addresses to plan appointments or send invoices.

Properties

Name Meaning
Customer ID The unique identifier of the customer whose addresses you want to retrieve.

Note: The provided properties JSON does not explicitly list input fields for the "Get All Addresses" operation, but from the bundled source code, the required property is customerId (string) which identifies the customer.

Output

The output of this operation is a JSON array containing all address objects associated with the specified customer. Each address object typically includes fields such as street, city, state, zip code, country, and possibly additional address details.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Housecall Pro API.
  • Requires an API authentication token credential configured in n8n to authorize requests.
  • The base URL for API requests is https://api.housecallpro.com.
  • No other external dependencies are needed.

Troubleshooting

  • Missing or invalid Customer ID: If the customerId parameter is missing or incorrect, the API will likely return an error indicating that the customer was not found. Ensure the correct customer ID is provided.
  • Authentication errors: If the API key or token is invalid or missing, the request will fail with an authentication error. Verify that the API credentials are correctly set up in n8n.
  • API rate limits: Frequent calls may hit API rate limits imposed by Housecall Pro. In such cases, wait before retrying or implement throttling.
  • Network issues: Connectivity problems can cause request failures. Check network access and proxy settings if applicable.

Links and References


If you want me to analyze other operations or resources, please provide their names or additional property definitions.

Discussion