HostBill icon

HostBill

Consume HostBill API (v.0.1.3)

Overview

This n8n node interacts with the HostBill API to retrieve client contact information associated with a specific client. The "Get by Client" operation under the "Client Contact" resource allows users to fetch a list of contacts for a given client, optionally supporting pagination. This is useful in scenarios where you need to automate workflows involving customer management, such as syncing client contacts to other systems, sending notifications, or performing bulk updates.

Practical examples:

  • Fetching all contacts for a particular client and adding them to a CRM.
  • Retrieving paginated lists of client contacts for reporting or auditing purposes.

Properties

Name Type Meaning
Client ID Number The unique identifier of the client whose contacts you want to retrieve.
Additional Fields Collection Optional fields to refine the request.
└─ Page Number (Within Additional Fields) Specifies which page of results to return.

Output

The output is a JSON array containing the retrieved client contact records. Each item in the array represents a client contact and includes fields as returned by the HostBill API for this operation. If an error occurs and "Continue On Fail" is enabled, the output will include objects with an error field describing the issue.

Example output structure:

[
  {
    "id": 123,
    "name": "John Doe",
    "email": "[email protected]",
    // ...other contact fields from HostBill API
  },
  {
    "id": 124,
    "name": "Jane Smith",
    "email": "[email protected]"
  }
]

If an error occurs for an item:

[
  {
    "error": "Error message here"
  }
]

Dependencies

  • External Service: Requires access to a HostBill instance with API enabled.
  • API Credentials: You must configure valid HostBill API credentials in n8n under the name hostBillApi.
  • n8n Configuration: No additional environment variables are required beyond standard credential setup.

Troubleshooting

  • Invalid Credentials: If your API credentials are incorrect or missing, the node will throw an authentication error. Ensure that the hostBillApi credentials are set up correctly in n8n.
  • Missing Required Property: If "Client ID" is not provided, the node will fail to execute. Always supply a valid client ID.
  • API Errors: If the HostBill API returns an error (e.g., client not found), the node will either throw an error or, if "Continue On Fail" is enabled, include the error message in the output.
  • Pagination Issues: If you request a page number that does not exist, the API may return an empty result or an error.

Links and References

Discussion