SugarCRM icon

SugarCRM

Interact with SugarCRM API

Actions40

Overview

This node interacts with the SugarCRM API to retrieve multiple Contact records based on specified criteria. It supports fetching many contacts either with or without query parameters, allowing users to filter or customize the data returned from SugarCRM.

Common scenarios where this node is beneficial include:

  • Synchronizing contact lists from SugarCRM into other systems.
  • Extracting filtered subsets of contacts for marketing campaigns.
  • Automating reporting by retrieving contacts matching specific conditions.

For example, a user might configure the node to get all contacts whose status is "Active" by sending appropriate query parameters, or simply fetch a limited number of recent contacts without filters.

Properties

Name Meaning
Send Query Parameters Whether to send query parameters with the request to filter or modify the results.
Specify Query Parameters How to specify the query parameters: either using individual fields below or providing a JSON object.
Query Parameters A collection of name-value pairs representing individual query parameters (used if specifying via fields).
Query Parameters (JSON) Query parameters provided as a JSON object (used if specifying via JSON).
Send JSON Body Whether to send a JSON body with the request (rarely used in Get Many operation).
JSON Body The JSON body content to send with the request if enabled.
Return All Whether to return all matching results or limit the number of results returned.
Limit Maximum number of results to return if not returning all (minimum 1).

Output

The output is an array of JSON objects, each representing a Contact record retrieved from SugarCRM. Each object contains the fields and values as returned by the SugarCRM API for a contact.

If no records are found, the node throws an error indicating no records were found or that the API response structure was unexpected.

The node does not output binary data.

Dependencies

  • Requires an API key credential for SugarCRM with access to the REST API.
  • Needs the base URL of the SugarCRM instance and valid authentication credentials (username, password, client ID, client secret).
  • The node handles OAuth2 token retrieval internally using these credentials.
  • No additional external dependencies beyond the SugarCRM API.

Troubleshooting

  • No records found or unexpected API response structure: This error occurs if the API returns no contacts or the response format differs from expected. Check query parameters for correctness and ensure the SugarCRM instance has matching data.
  • Authentication errors: If the node cannot authenticate, verify that the API credentials are correct and have sufficient permissions.
  • Invalid JSON input: When specifying query parameters or JSON body as JSON strings, ensure the JSON syntax is valid.
  • Limit vs Return All: Setting a low limit while expecting many results may cause incomplete data; use "Return All" to fetch all records but be mindful of performance.

Links and References

Discussion