Exante CRM icon

Exante CRM

Interact with Exante CRM API to manage applications, documents, and more
Join our community

Actions11

Overview

This node interacts with the Exante CRM API to retrieve detailed information about a specific tag by its ID. It is useful in scenarios where you need to fetch metadata or properties associated with tags used within the CRM system, such as categorizing or labeling applications, documents, or other entities.

Practical examples include:

  • Retrieving tag details to display or process them in workflows.
  • Validating tag existence before assigning tags to objects.
  • Integrating tag data into reports or dashboards.

Properties

Name Meaning
Environment Selects the API environment to use: Production, Staging, or Custom API URL.
Custom API URL (Shown only if Environment is "Custom") The base URL for the custom API (e.g., https://api.example.com). The /api prefix will be added automatically.
Custom Auth URL (Shown only if Environment is "Custom") The OAuth2 token endpoint URL for authentication.
Tag ID The unique identifier of the tag to retrieve. This is required to specify which tag to get.

Output

The output is a JSON object representing the retrieved tag's details as returned by the Exante CRM API. The exact structure depends on the API response but typically includes fields describing the tag's attributes such as its name, description, and any related metadata.

No binary data output is produced by this operation.

Example output snippet (conceptual):

{
  "id": "123",
  "name": "Priority",
  "description": "Indicates priority level",
  "created_at": "2023-01-01T12:00:00Z"
}

Dependencies

  • Requires an API key credential configured with OAuth2 authentication to access the Exante CRM API.
  • The node supports three environments: Production, Staging, and Custom. For Custom, users must provide both the API base URL and the OAuth2 token endpoint URL.
  • The node uses internal helper classes to manage authentication tokens and API requests.

Troubleshooting

  • Missing Tag ID: If the Tag ID property is empty, the node will throw an error indicating that the Tag ID is required. Ensure you provide a valid tag identifier.
  • Invalid Custom URLs: When using the Custom environment, both the Custom API URL and Custom Auth URL must be provided; otherwise, the node will raise an error.
  • Authentication Failures: Errors related to obtaining or refreshing the OAuth2 token may occur if credentials are invalid or expired. Verify your API key and OAuth2 settings.
  • API Errors: If the API returns errors (e.g., tag not found), these will be surfaced in the node's output as error messages. Check the tag ID correctness and API availability.
  • JSON Parsing Issues: Not applicable for this operation since it does not accept JSON input.

Links and References

Discussion