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 about endpoints. Specifically, the 'Get All Endpoints' operation fetches a list of endpoints with optional filtering, sorting, and pagination. It is useful for scenarios where users need to manage or analyze multiple API endpoints, such as monitoring enabled endpoints, searching by URL, or limiting the number of results for display or processing.

Use Case Examples

  1. Retrieve all enabled endpoints with a limit of 10 results to display in a dashboard.
  2. Search endpoints by URL substring to find specific API routes.
  3. Sort endpoints by name or reference to organize the output for reporting.

Properties

Name Meaning
Limit Maximum number of entries to return in the response.
Offset Starting offset for the list of entries, used for pagination.
Search Search string to filter endpoints by URL.
Is Enabled Boolean filter to include only enabled or disabled endpoints.
Sort Sort order of results, supporting multiple comma-separated values such as 'url' or '-url' to specify ascending or descending order.

Output

JSON

  • json - The JSON response from the Billing Booth One API containing the list of endpoints 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 may cause the API to return errors or empty results.
  • Network connectivity issues can prevent successful API requests.
  • If the binary property name is specified but the binary data is missing, an error is thrown.

Links

Discussion