Actions20
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 actually belongs to the Customer resource in the code), it retrieves all addresses associated with a specific customer.
A common use case is when you want to fetch all stored addresses of a customer to display them, update records, or use them for scheduling or invoicing purposes. For example, a service company might use this to pull all locations where a customer has requested services.
Properties
Name | Meaning |
---|---|
Customer ID (customerId ) |
The unique identifier of the customer whose addresses you want to retrieve. |
Note: The provided properties JSON does not explicitly list input fields for "Get All Addresses" under Application resource, but from the bundled source code, the operation get-customer-customer_id-addresses
requires a customerId
string parameter to specify which customer's addresses to get.
Output
The output will be a JSON array containing address objects associated with the specified customer. Each address object typically includes fields like street, city, state, zip, country, and possibly additional address lines.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the Housecall Pro API.
- The base URL for API requests is
https://api.housecallpro.com
. - Proper configuration of the API key credential within n8n is necessary for successful requests.
Troubleshooting
- Missing or invalid Customer ID: If the
customerId
is not provided or incorrect, the API will likely return an error indicating that the customer was not found. - Authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions.
- API rate limits: Frequent calls may hit rate limits imposed by Housecall Pro; handle such errors by implementing retries or backoff.
- Network issues: Connectivity problems can cause request failures; verify network access to the Housecall Pro API endpoint.