Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated in the code). It supports multiple resources and operations, including the "User" resource with the "Get Bound Company Lists" operation. The node fetches data related to users bound to specific companies and hubs within the Ajax system.

Common scenarios for this node include:

  • Retrieving a list of companies associated with a particular user or hub.
  • Enriching company data with additional details if requested.
  • Integrating Ajax user-company relationships into workflows for automation or reporting.

For example, you might use this node to get all companies linked to a user identified by a company ID and hub ID, optionally enriching the returned data with more detailed information.

Properties

Name Meaning
Company Id The unique identifier of the company for which to retrieve bound user lists.
Hub Id The unique identifier of the hub associated with the company and user.
Additional Fields Optional fields to customize the request; currently supports: Enrich (boolean) to specify whether to enrich the returned data with additional details.

Output

The node outputs JSON data representing the list of companies bound to the specified user and hub. The structure typically includes company details and, if enrichment is enabled, additional enriched information about each company.

If binary data were involved, it would be summarized here, but based on the provided code and properties, the output is purely JSON.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the external Ajax API service being accessible.
  • Uses internal helper classes for HTTP requests, state management, and operation resolution/execution.
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Missing or invalid credentials: Ensure that a valid API key credential is configured for the node; otherwise, authentication will fail.
  • Invalid Company Id or Hub Id: Providing incorrect or non-existent IDs may result in empty results or errors from the API.
  • Network issues: Connectivity problems to the Ajax API endpoint can cause timeouts or failures.
  • Enrichment option misuse: If the Enrich field is set incorrectly (e.g., non-boolean), the node might not behave as expected.

Common error messages likely relate to authentication failures, invalid parameters, or network errors. To resolve these, verify credentials, input values, and network connectivity.

Links and References

Discussion