CiviCRMInstall

Summary

Execute a legacy 'get' API call on any specified CiviCRM API4 entity, passing raw JSON parameters to retrieve data. Use the 'Entity' input to specify the API4 entity (e.g., Contact, Membership), 'Action' to select the API action (default 'get'), 'Params (JSON)' for the raw API parameters as a JSON object string, and optionally provide a 'Runtime Bearer Token' for user-specific authentication or a 'Base URL Override' to target a different CiviCRM instance. The node returns the raw API response, including values and metadata, allowing direct access to the data retrieved by the custom API call.

Inputs

• Entity (required) — Specify the CiviCRM API4 entity you want to query, such as Contact, Membership, Group, Activity, or CustomValue.
• Action (required) — Specify the CiviCRM API4 action to perform, for example 'get', 'getFields', 'create', 'update', 'delete', or 'getOne'. Defaults to 'get'.
• Params (JSON) (required) — Provide the raw API4 parameters as a valid JSON object string to be sent to CiviCRM. This JSON must be correctly formatted without trailing commas.
• Runtime Bearer Token (Optional) — Provide an optional JWT token issued for a specific real user to authenticate the API call. If set, it overrides the node credentials and is used as the Bearer token in authorization headers. Leave empty to use the node's credential-based authentication.
• Base URL Override — Optionally specify a different base URL for the CiviCRM instance you want to target, overriding the credential's base URL. If no scheme is specified, 'https://' is assumed.

Output shape

The operation returns the raw JSON response from the CiviCRM API v4 call, which includes the 'values' array and any additional metadata returned by the API.

The result is the full API response and is returned as individual items for each API call executed. When using the 'Runtime Bearer Token' option, empty or error responses are returned as-is without retrying using the credential API key. Ensure that 'Params (JSON)' is valid JSON; invalid JSON will trigger an error. This operation corresponds to the legacy 'get' behavior but internally dispatches as a raw API call.

Examples

Example 1: Retrieve up to 25 Contact entities with a specific filter using the 'get' action on the 'Contact' entity, with parameters set in JSON format. Optionally, supply a runtime bearer token for user-specific permissions.

Entity: Contact; Action: get; Params (JSON): { "limit": 25, "where": [["city", "=", "New York"]] }; Runtime Bearer Token: (optional JWT string); Base URL Override: (optional URL)

Links

• n8n community nodes installation guide