Actions20
Overview
This node interacts with the Housecall Pro API to retrieve a list of customers. Specifically, the "Get All" operation under the "Customer" resource fetches multiple customer records based on optional filtering, pagination, and sorting parameters.
Common scenarios where this node is beneficial include:
- Synchronizing customer data from Housecall Pro into another system.
- Displaying or processing a filtered list of customers within an automation workflow.
- Paginating through large customer datasets for reporting or batch processing.
For example, you could use this node to get all customers whose name or email matches a search query, sorted by creation date in descending order, retrieving 10 customers per page.
Properties
| Name | Meaning |
|---|---|
| Search Query (q) | A string query to search customers by name, email, mobile number, or address. |
| Page | The current page number of results to retrieve (pagination). |
| Items Per Page | Number of customers to return per page. |
| Sort By | Customer attribute to sort the results by. Currently supports "Created At". |
| Sort Direction | Direction to sort the results: "Ascending" or "Descending". |
These properties are provided inside the "Additional Fields" collection when performing the "Get All" operation on customers.
Output
The node outputs JSON data representing the list of customers retrieved from the Housecall Pro API. Each item in the output corresponds to a customer object containing their attributes as returned by the API.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating requests to the Housecall Pro API.
- The base URL used for API requests is
https://api.housecallpro.com. - Proper configuration of the API key credential in n8n is necessary for successful execution.
Troubleshooting
- Empty Results: If no customers are returned, verify that the search query and pagination parameters are correct and that customers exist matching those criteria.
- Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
- Invalid Parameter Values: Passing invalid values for pagination or sorting may cause errors; ensure numbers are positive and options are selected from allowed values.
- API Rate Limits: Frequent calls might hit rate limits imposed by Housecall Pro; consider adding delays or handling retries.