Cloodo CRM

Get data from Cloodo API

Actions62

Overview

This node interacts with the "Engagement" resource of the Cloodo CRM API, specifically supporting the operation to "Get Many Engagements." It retrieves multiple engagement records based on various filtering and pagination options. This is useful for scenarios where you want to list or analyze multiple engagements related to tickets, requesters, projects, or other criteria within your CRM system.

Practical examples include:

Fetching all open engagements assigned to a specific requester.
Retrieving engagements filtered by status (e.g., resolved or closed) within a date range.
Paginating through large sets of engagement data using cursors.
Searching engagements by keywords or ticket IDs.

Properties

Name	Meaning
Page (cursor)	The pagination cursor to fetch a specific page of results.
Additional Fields	A collection of optional filters and parameters to refine the query:
- Search	Text string to search engagements by keyword.
- ticketID	Numeric ID of a ticket to filter engagements related to that ticket.
- Requester	Numeric ID of the requester to filter engagements by requester.
- Page (cursor)	Pagination cursor (same as above) to navigate pages of results.
- Sort	Sorting order of results; can be "desc" (descending) or "asc" (ascending).
- Status	Filter engagements by status; options are "Open", "Pending", "Resolved", or "Closed".
- From Date	Start date to filter engagements created from this date (format expected by API).
- To Date	End date to filter engagements up to this date (format expected by API).
- Type ID	Filter by type identifier of the engagement.
- Channel ID	Filter by channel identifier associated with the engagement.
- Project ID	Filter engagements related to a specific project by its ID.

Output

The node outputs an array of engagement objects in the json field of the output data. Each object represents an individual engagement record retrieved from the Cloodo CRM API. The exact structure depends on the API response but typically includes fields such as engagement ID, status, requester info, ticket details, timestamps, and other metadata.

If the API supports binary data for engagements (not indicated here), it would be included accordingly, but this node primarily deals with JSON data representing engagement records.

Dependencies

Requires an active connection to the Cloodo CRM API.
Needs an API authentication token or key configured in n8n credentials (referred generically as "an API key credential").
The base URL used is https://erp-amz.cloodo.com/v4/.
Proper network access to the Cloodo API endpoint.

Troubleshooting

Empty Results: If no engagements are returned, verify that the filter parameters (status, dates, requester, etc.) are correct and that there is matching data in the CRM.
Invalid Cursor/Page: Using an invalid or expired cursor value may result in errors or empty responses. Reset the cursor or start from the first page.
Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to read engagement data.
Date Format Issues: The From Date and To Date fields must be in the format expected by the API (usually ISO 8601). Incorrect formats may cause the API to reject the request.
API Rate Limits: Excessive requests might trigger rate limiting; implement delays or pagination properly.
Unexpected API Errors: Check the error message returned by the API for clues; common issues include invalid parameter names or values.

Links and References

Cloodo CRM API Documentation (Assumed URL based on base URL, please verify)
n8n Documentation on Creating Custom Nodes
General REST API Pagination Concepts: https://restfulapi.net/pagination/

Note: This summary is based solely on static analysis of the provided source code and property definitions without runtime execution or external API inspection.