CiviCRM

Interact with CiviCRM API v4 (Civi-Go compatible). Supports Contact, Membership, Group, Relationship and Activity entities. Includes dynamic mapping of email, phone, address and location types. Includes birth_date validation and JSON filters for GET MANY.
Join our community

Actions30

Overview

This node interacts with the CiviCRM API v4 to retrieve multiple membership records based on specified criteria. It supports filtering memberships using JSON-based conditions and allows users to either return all matching records or limit the number of results. This is useful for scenarios where bulk membership data retrieval is needed, such as generating reports, syncing membership data with other systems, or performing batch updates.

Use Case Examples

  1. Retrieve all memberships with a specific status or type by providing a JSON filter in the 'Where (JSON)' field.
  2. Limit the number of memberships returned to 100 for performance reasons by setting 'Return All' to false and 'Limit' to 100.

Properties

Name Meaning
Return All Determines whether to return all matching membership records or limit the number of results.
Limit Specifies the maximum number of membership records to return when 'Return All' is false.
Where (JSON) A JSON string representing filter conditions to apply when retrieving memberships, e.g., filtering by membership status or other fields.

Output

JSON

  • id - Unique identifier of the membership record.
  • name - Name of the membership.
  • title - Title associated with the membership.
  • subject - Subject or description of the membership.
  • display_name - Display name for the membership record.

Dependencies

  • Requires an API key credential for authenticating with the CiviCRM API v4.

Troubleshooting

  • Invalid JSON in the 'Where (JSON)' field will cause an error; ensure the JSON is correctly formatted.
  • API request failures may occur due to incorrect credentials or network issues; verify API key and connectivity.
  • If no memberships are returned, check the filter conditions in the 'Where (JSON)' field to ensure they match existing records.

Links

Discussion