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 Customer Access Banners. Specifically, for the 'Get All Customer Access Banners' operation, it fetches a list of customer access banners associated with a given organisation. This is useful for scenarios where users need to manage or display banners for customers, such as in customer portals or internal dashboards. Practical examples include retrieving banners to show on a website or to audit banner usage across an organisation.

Use Case Examples

  1. Retrieve all customer access banners for organisation ID 1 with a limit of 10 entries.
  2. Search customer access banners with a specific description and sort results by description or clicks.

Properties

Name Meaning
Organisation Id Unique identifier of the organisation to fetch customer access banners for.
Additional Fields Optional parameters to refine the query such as limit, offset, search term, and sort order.

Output

JSON

  • json - The JSON response from the Billing Booth One API containing the list of customer access banners 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 missing required parameters such as organisationId may cause the API request to fail.
  • Network or API endpoint issues may cause request failures; ensure the base URL is correct and accessible.
  • Error messages from the API are propagated; users should check the error details in the node output for troubleshooting.

Links

Discussion