CiviCRMInstall

Summary

Execute a raw CiviCRM APIv4 call to any specified entity and action with custom JSON parameters, allowing advanced users to send hand-crafted requests directly to CiviCRM endpoints.

Inputs

• Entity (required) — The CiviCRM APIv4 entity name to call, e.g., Contact, Membership, Group, Activity, CustomValue.
• Action (required) — The CiviCRM APIv4 action to perform on the entity, e.g., get, getFields, create, update, delete, getOne.
• Params (JSON) (required) — A JSON string representing the raw parameters to pass exactly as-is to the CiviCRM API4 action. Must be valid JSON object syntax without trailing commas.
• Runtime Bearer Token (Optional) — A JWT token string representing a specific real user's authorization. If provided, this token is used as the Authorization Bearer header and no credential fallback is applied. Useful for per-user permission enforcement.
• Base URL Override — An optional URL string to override the credential's Base URL for this API call, enabling use of the same API key with multiple CiviCRM instances. If no scheme is provided, https:// is assumed.

Output shape

a single JSON object representing the raw CiviCRM APIv4 response object including values and metadata for the requested entity/action.

Outputs the raw API response as JSON exactly as returned by CiviCRM. No additional processing or simplification is performed. Errors and empty responses are returned or thrown as-is depending on the provided authorization token or credentials.

Examples

Example 1: Retrieve a list of contacts

Set Entity to 'Contact', Action to 'get', and Params (JSON) to specify filters or limits such as {"limit":10}. Use optional Runtime Bearer Token if per-user authorization is needed.

Example 2: Create a new custom entity record

Set Entity to the custom entity name, Action to 'create', and Params (JSON) to the field values object for the new record. Run the node to create the entity record via raw API call.

Links

• n8n community nodes installation guide