Exante CRM icon

Exante CRM

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

Actions11

Overview

This node integrates with the Exante CRM API, allowing users to manage various CRM entities such as applications, documents, document types, tags, and tag values. Specifically, for the Document Type - Get operation, it retrieves detailed information about a single document type by its unique identifier.

Typical use cases include:

  • Fetching metadata or configuration details of a specific document type stored in the CRM.
  • Automating workflows that require validation or processing based on document type attributes.
  • Integrating document type data into other systems or reports.

For example, a user might want to retrieve the properties of a "Contract" document type before generating or validating contract documents automatically.

Properties

Name Meaning
Environment Selects the API environment to connect to: Production, Staging, or Custom (custom URLs).
Custom API URL When using a custom environment, specify the base API URL here (the /api prefix is added automatically).
Custom Auth URL When using a custom environment, specify the OAuth2 token endpoint URL for authentication.
Document Type ID The unique identifier of the document type to retrieve. This is required for the Get operation.

Output

The output is a JSON object representing the requested document type's details as returned by the Exante CRM API. The exact structure depends on the API response but typically includes fields describing the document type's attributes, metadata, and configuration.

If multiple items were processed (e.g., via input items), the output will be an array of such JSON objects, each corresponding to one document type retrieval.

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential configured with OAuth2 authentication to access the Exante CRM API.
  • Supports connecting to predefined environments (Production, Staging) or a custom API URL with a custom OAuth2 token endpoint.
  • The node internally manages OAuth2 token acquisition and refresh using the provided credentials and URLs.

Troubleshooting

  • Missing Document Type ID: If the Document Type ID property is empty, the node will throw an error indicating that this field is required.
  • Invalid Custom URLs: When selecting 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 during OAuth2 token retrieval may occur if credentials are invalid or URLs are incorrect. Verify the API key and URLs.
  • API Errors: If the specified Document Type ID does not exist or the API returns an error, the node will propagate the error message. Check the ID correctness and API permissions.
  • JSON Parsing Issues: Not applicable for this operation but relevant for other operations involving JSON inputs.

Links and References

Discussion