Overview
This node interacts with the SuiteCRM API to perform various operations on CRM modules. Specifically, the 'Get By ID' operation retrieves a single item from a specified module using its unique ID. This is useful for fetching detailed information about a specific record in SuiteCRM, such as a contact, lead, or custom module entry, by providing its ID.
Use Case Examples
- Retrieve a contact's details by their contact ID.
- Fetch a specific lead's information using its unique ID.
- Get data from a custom module by specifying the module path and record ID.
Properties
| Name | Meaning |
|---|---|
| Module | The SuiteCRM module on which to perform the operation, e.g., Contacts, Leads, or a custom module. |
| Custom Module Path | If 'Custom' module is selected, specify the custom module path directly. |
| ID | The unique identifier of the item to retrieve from the specified module. |
| Description | Optional description for the node instance. |
Output
JSON
id- The unique identifier of the retrieved item.type- The type of the item, typically the module name.attributes- The attributes or fields of the retrieved item with their values.
Dependencies
- Requires SuiteCRM API credentials for authentication.
Troubleshooting
- Common issues include providing an incorrect module name or ID, resulting in errors or empty responses.
- Ensure the SuiteCRM API credentials are correctly configured and have sufficient permissions.
- Error messages may indicate network issues, invalid IDs, or permission problems; verify the input parameters and API access rights.
Links
- SuiteCRM Documentation - Official documentation for SuiteCRM API usage and module details.