Actions20
Overview
This node interacts with the Housecall Pro API to retrieve a list of customers. It is designed to fetch multiple customer records with support for filtering, pagination, and sorting. This operation is useful in scenarios where you need to synchronize customer data from Housecall Pro into another system, generate reports on customers, or perform bulk operations based on customer lists.
For example, you could use this node to:
- Retrieve all customers who match a specific search query (e.g., by name or email).
- Paginate through large customer datasets to process them in batches.
- Sort customers by their creation date in ascending or descending order.
Properties
| Name | Meaning |
|---|---|
| Search Query | A string query to search customers by name, email, mobile number, or address. |
| Page | The current page number of the paginated results (default is 1). |
| Items Per Page | Number of customers to return per page (default is 10). |
| Sort By | Customer attribute to sort the results by. Currently supports "Created At". |
| Sort Direction | Direction to sort the results: "Ascending" or "Descending". |
Output
The output JSON contains an array of customer objects retrieved from the Housecall Pro API. Each object represents a customer with their associated attributes such as name, contact details, company, and other metadata.
If binary data were supported, it would typically represent attachments or files related to customers, but this operation only returns JSON data about customers.
Dependencies
- Requires an active connection to the Housecall Pro API.
- An API authentication token or API key credential must be configured in n8n to authorize requests.
- The base URL for API requests is
https://api.housecallpro.com.
Troubleshooting
- Empty Results: If no customers are returned, verify that the search query is correct and that the page and page size parameters are set appropriately.
- Authentication Errors: Ensure that the API key or authentication token is valid and has sufficient permissions to access customer data.
- Rate Limits: The Housecall Pro API may enforce rate limits; if you encounter errors related to too many requests, consider adding delays or reducing request frequency.
- Invalid Parameter Values: Passing invalid values for pagination or sorting options may cause errors; ensure numeric fields like page and page_size are positive integers and sort options are valid.