efficy Enterprise CRM icon

efficy Enterprise CRM

Calls the efficy Enterprise JSON API API

Actions28

Tool → Get Setting

AI-generated

Summary

Read an efficy Enterprise CRM server setting by its name, optionally scoped to a module, and retrieve its value from the API.

Inputs

  • Setting Name (required) — Name of the efficy setting to read
  • Module — Module that owns the setting as a JSON object; leave blank to read a global setting.
  • Return As String — Boolean flag to return DateTime values as formatted strings instead of floats.
  • Options — Optional settings, including 'Return Full Response' to get the complete API response array instead of the first context result.

Output shape

a single JSON object representing the setting retrieved, or the full API response array if requested

Defaults to returning the first context result JSON object from the API response. If 'Return Full Response' option is enabled, returns the entire response array. Errors from the API are surfaced as node execution errors unless configured to continue on failure.

Examples

Example 1: Read the 'UseLinkedFile' setting globally

Provide 'UseLinkedFile' in Setting Name and leave Module empty

Example 2: Read a module-specific setting returning DateTime as string

Provide the Setting Name, specify the owning module as JSON, and enable 'Return As String' option

Links

Discussion