CiviCRMInstall

Summary

Retrieves multiple CiviCRM Membership records with optional filtering, pagination, and custom headers.

Inputs

• limit — Maximum number of results to return. Defaults to 100. Only applies when 'Return All' is false.
• returnAll — If true, retrieves all matching results via pagination. Defaults to false.
• whereJson — JSON array of filtering conditions in the format [[field, operator, value]].
• runtimeBearerToken — A pre-issued JWT for a specific CiviCRM user. If set, it is used as the Authorization header and bypasses credential-based JWT auto-resolve and API key fallback.
• baseUrlOverride — Optional Base URL to replace the credential's Base URL for this execution. Useful when the same API key is used across multiple CiviCRM instances.

Output shape

A list of Membership record items. Each item contains the standard CiviCRM APIv4 fields for the Membership entity.

When 'Return All' is true, results are paginated in chunks of 500 records. The node returns an empty list if no matching records are found or if the Runtime Bearer Token lacks permission.

Examples

Example 1: Fetch all active memberships for a specific contact ID

Where (JSON): [['contact_id', '=', 123]], Return All: true

Example 2: Retrieve up to 50 memberships with a custom filter

Where (JSON): [['status_id:name', '=', 'Active']], Limit: 50

Example 3: Query using a runtime JWT for a specific user

Runtime Bearer Token: ={{ $.user_jwt }}, Where (JSON): [['membership_type_id:name', '=', 'Gold']]

Links

• n8n community nodes installation guide