Beex icon

Beex

Beex Contact Center API Interaction and Consumption

User → Get Many

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve multiple user details based on specified search parameters. It is useful for scenarios where you need to fetch user information such as filtering users by search terms or profile IDs, and controlling the number of results returned. For example, it can be used to get a list of users matching a search query or belonging to a specific profile, with options to paginate through results.

Use Case Examples

  1. Retrieve all users matching a search term 'John' with a limit of 10 results.
  2. Fetch users belonging to a specific profile ID with pagination support.

Properties

Name Meaning
Search User search parameter to filter users by name or other attributes.
Profile User Profile ID to filter users by their profile.
Return All Boolean flag to determine whether to return all results or limit the number of results.
Limit The maximum number of user records to return when Return All is false.
Offset The page number to retrieve, used for pagination starting from 0.

Output

JSON

  • json - User details returned from the Beex API, potentially multiple user records.

Dependencies

  • Beex Contact Center API
  • API key credential for authentication

Troubleshooting

  • Common issues include API authentication errors due to invalid or missing API key credentials. Ensure the API key is correctly configured in the node credentials.
  • Errors related to invalid parameters such as incorrect profile IDs or search terms may occur. Verify input parameters are valid and correctly formatted.
  • API rate limiting or network issues may cause request failures. The node includes a delay between requests to mitigate rate limits, but network stability should be checked.

Links

Discussion