CiviCRMInstall

Summary

Retrieves multiple Relationship records from CiviCRM, optionally filtering by JSON criteria or a specific contact type.

Inputs

• returnAll — If true, retrieves all matching results; otherwise limits results to the configured number.
• limit — Maximum number of results to return. Defaults to 100. Only used when returnAll is false.
• whereJson — JSON array of arrays defining filter conditions (e.g., [["contact_a_id", "=", 1], ["relationship_type_id", "IN", ["1", "2"]]]).
• runtimeBearerToken — A pre-issued JWT for a specific real user (e.g., Authx JWT). If provided, it is used as the Authorization header and overrides the node's credential-based JWT and API key fallback.
• baseUrlOverride — Optional URL to override the credential's Base URL for this item (site root, without /civicrm).

Output shape

A list of items, each containing a Relationship record with fields such as id, contact_a_id, contact_b_id, relationship_type_id, and display_name.

When returnAll is true, the node paginates results in pages of 500 items. The 'runtimeBearerToken' parameter takes absolute priority; an empty result or error with this token is returned as-is without falling back to the credential's API key.

Examples

Example 1: Retrieve the first 10 active relationships between two specific contacts.

Set returnAll to false, limit to 10, and use whereJson to filter by contact_a_id and contact_b_id.

Example 2: Fetch all relationships for a specific contact ID.

Set returnAll to true to bypass the 100-item default limit.

Links

• n8n community nodes installation guide