Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API

Actions476

Overview

This node interacts with the Billing Booth One API to retrieve data related to various resources, including Contacts. Specifically, for the 'Get All Contacts' operation, it fetches a list of contacts with support for filtering, pagination, and sorting. This is useful for scenarios where users need to manage or analyze contact data from Billing Booth One, such as exporting contact lists, integrating contact data into other workflows, or performing bulk operations based on contact information.

Use Case Examples

  1. Retrieve all contacts with a limit of 10 entries to display in a dashboard.
  2. Search contacts by email to find specific users.
  3. Sort contacts by email in ascending or descending order for reporting purposes.

Properties

Name Meaning
Limit Maximum number of contact entries to return in the response.
Offset Starting offset for the list of contacts, used for pagination.
Search Search filter applied to contact emails to find matching entries.
Sort Sort order of the results, allowing multiple fields separated by commas, e.g., 'email' or '-email' for descending order.

Output

JSON

  • json - The JSON response from the Billing Booth One API containing the list of contacts and their details.

Dependencies

  • Requires an API key credential for Billing Booth One API authentication.

Troubleshooting

  • Common issues include missing or invalid API credentials, resulting in authentication errors.
  • Incorrect or unsupported query parameters (e.g., invalid limit or offset values) may cause API request failures.
  • Network connectivity issues can prevent successful API calls.
  • Error messages from the node typically indicate the nature of the failure, such as missing routing information for the specified resource and operation, or missing binary data if expected.

Discussion