Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Actions59

Client → Get Many

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve multiple client records based on a specified date range and pagination parameters. It is useful for scenarios where users need to fetch client data created within a certain timeframe, such as generating reports or syncing client information with other systems.

Use Case Examples

  1. Retrieve all clients created between January 1, 2023, and January 31, 2023, to analyze new customer acquisition.
  2. Fetch a limited number of client records for a specific page to display in a dashboard or application.

Properties

Name Meaning
Start Date Start date for filtering clients by their creation date (format YYYY-MM-DD 00:00:00). This is a required parameter to specify the beginning of the date range.
End Date End date for filtering clients by their creation date (format YYYY-MM-DD 00:00:00). This is a required parameter to specify the end of the date range.
Return All Boolean flag to determine whether to return all results or limit the number of results returned.
Limit The maximum number of client records to return when Return All is false. Defines the page size.
Offset The page number to retrieve, starting from 0, ordered descending by creation date.

Output

JSON

  • json - Client record data returned from the Beex API, which may include multiple client objects in an array.

Dependencies

  • Beex Contact Center API with an API key credential

Troubleshooting

  • Common issues include invalid or missing API key credentials, which will cause authentication errors.
  • Incorrect date formats for Start Date or End Date may result in API errors or empty results.
  • Pagination parameters (Limit and Offset) must be valid numbers; otherwise, the API may return errors or unexpected results.
  • API rate limits may cause delays or errors; the node includes a delay between requests to mitigate this.

Links

Discussion