Beex icon

Beex

Interacción y Consumo de la API Beex Contact Center.

Actions9

Overview

This node interacts with the Beex Contact Center API to retrieve user information. Specifically, the "User" resource with the "Obtener" (Get) operation allows you to search and fetch details about users in the system. It supports filtering by search terms and user profile IDs, as well as pagination controls.

Common scenarios where this node is beneficial include:

  • Fetching a list of users matching certain criteria for reporting or synchronization.
  • Retrieving user profiles filtered by specific roles or attributes.
  • Integrating user data from Beex into other workflows or systems.

For example, you could use this node to get all users with a particular profile ID or to search users by name or email substring, then process or export that data downstream.

Properties

Name Meaning
Búsqueda Search parameter to filter users by a text string (e.g., name, email).
Perfil User profile ID to filter users belonging to a specific profile.
Return All Boolean flag indicating whether to return all matching results or limit the number fetched.
Limit Number specifying the page size (how many users to return per request), from 1 upwards.
Offset Page number to retrieve, ordered descending by creation date, starting at 0.

Output

The node outputs JSON data containing an array of user objects retrieved from the Beex API endpoint /users/users. Each object represents a user with their associated details as provided by the API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Beex Contact Center API.
  • The base URL for API requests is https://api.beexcontact.com/api/v1.
  • Proper configuration of the API key credential in n8n is necessary for successful execution.

Troubleshooting

  • Empty Results: If no users are returned, verify that the search parameters (Búsqueda, Perfil) are correct and match existing users.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • Pagination Issues: When using Return All set to false, ensure Limit and Offset values are within valid ranges; invalid values may cause errors or unexpected results.
  • API Rate Limits: Excessive requests might be throttled by the API; consider adding delays or handling rate limit responses gracefully.

Links and References

Discussion