SugarCRM icon

SugarCRM

Interact with SugarCRM API

Actions40

Overview

This node allows interaction with the SugarCRM API, specifically supporting operations on various resources including a customizable "Other" resource via a custom endpoint. The Get Many operation for the "Other" resource retrieves multiple records from a specified custom SugarCRM module endpoint.

Typical use cases include:

  • Fetching bulk data from a custom SugarCRM module that is not covered by standard resource types.
  • Querying records with optional filtering through query parameters.
  • Retrieving all records or limiting the number of results returned.

For example, you might use this node to get all customer feedback entries stored in a custom SugarCRM module named CustomerFeedback_c, optionally filtering by status or date range using query parameters.

Properties

Name Meaning
Custom Endpoint The specific custom SugarCRM module endpoint to query (e.g., CustomModule_c).
Send Query Parameters Whether to include query parameters in the request URL to filter or modify the response.
Specify Query Parameters How to specify query parameters: either by entering individual fields or providing a JSON object.
Query Parameters List of name-value pairs representing individual query parameters (used if specifying via fields).
Query Parameters (JSON) JSON object representing query parameters (used if specifying via JSON).
Send JSON Body Whether to send a JSON body with the GET request (less common but supported).
JSON Body JSON object to send as the request body if enabled.
Return All Whether to return all matching records or limit the number of results.
Limit Maximum number of records to return if not returning all (minimum 1).

Output

The node outputs an array of JSON objects under the json field, each representing a record retrieved from the specified custom SugarCRM endpoint. Each object corresponds to one record and contains all fields returned by the SugarCRM API for that record.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for SugarCRM API access, including base URL and authentication details.
  • Uses OAuth2 password grant flow to obtain an access token before making API requests.
  • Relies on the SugarCRM REST API v11_11 endpoints.
  • Requires n8n configuration to provide these credentials securely.

Troubleshooting

  • No records found or unexpected API response structure: This error occurs if the API returns no records or the response format differs from expected. Verify the custom endpoint name and query parameters are correct.
  • Authentication errors: If the node fails to authenticate, check that the provided API credentials (client ID, secret, username, password) are valid and have sufficient permissions.
  • Invalid JSON input: When specifying query parameters or JSON body as JSON strings, ensure the JSON syntax is correct to avoid parsing errors.
  • Limit vs Return All: If you expect more records than the limit but do not enable "Return All," only the limited subset will be returned.

Links and References

Discussion