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 perform various operations on different resources. Specifically, for the 'Users' resource with the 'Get All Users' operation, it retrieves a list of users from the API. It supports filtering, sorting, and pagination through input parameters such as limit, offset, search by email, and sort order. This node is useful for scenarios where you need to fetch user data for reporting, synchronization, or further processing in workflows.

Use Case Examples

  1. Fetch all users with a limit of 10 entries to display in a dashboard.
  2. Search users by email containing a specific string and sort results by email.
  3. Paginate through user records by setting offset and limit parameters.

Properties

Name Meaning
Limit Maximum number of user entries to return from the API.
Offset Starting offset for the list of users, used for pagination.
Search Search users by their email address.
Sort Sort order of the user results, supporting multiple comma-separated values such as 'email' or '-email'.

Output

JSON

  • json - The JSON response from the Billing Booth One API containing the list of users 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.
  • Error messages from the node typically include the API error message; ensure parameters like limit, offset, and search are correctly formatted.

Links

Discussion