QContact icon

QContact

Consume QContact API (v.0.1.3)

Actions7

Overview

The QContact Entities Filter operation allows users to query and filter entities from the QContact API based on customizable conditions. This node is ideal for scenarios where you need to retrieve a subset of entities matching specific criteria, such as filtering contacts by status, date, or custom fields. Practical examples include:

  • Fetching all active customers created in the last 30 days.
  • Retrieving entities with a specific attribute value (e.g., email contains "example.com").
  • Combining multiple filter conditions using AND/OR logic.

Properties

Name Type Meaning
Entity options The type of entity to filter (e.g., Contact, Company).
Simplify boolean Whether to return a simplified version of the response instead of the raw data.
As JSON boolean If enabled, allows providing filter parameters as a raw JSON object.
JSON json The JSON object containing filter parameters (used when "As JSON" is true).
Combine options Logical operator to combine conditions: "All (AND)" or "Any (OR)".
Conditions fixedCollection List of filter conditions. Each condition includes:
- Name: Field name
- Operator: Comparison type (equals, not-equal, etc.)
- Value: Value to compare against.
Optional Params collection Additional optional parameters:
- Fields: Specific fields to return
- Sort Field: Field to sort by
- Sort Direction: Ascending/Descending
- View: Listview name.

Output

  • The output is a list of filtered entities matching the specified conditions.
  • If "Simplify" is enabled, the output will be a streamlined JSON structure with only essential fields.
  • If "Simplify" is disabled, the output will contain the full raw data returned by the QContact API.
  • The output is always in the json field of each item.
  • No binary data is produced by this operation.

Example Output Structure

[
  {
    "json": {
      "id": "123",
      "name": "John Doe",
      "email": "john@example.com",
      // ...other fields depending on selected options
    }
  },
  ...
]

Dependencies

  • External Service: Requires access to the QContact API.
  • API Key: Must provide valid QContact API credentials via n8n's credential system (qContactApi).
  • n8n Configuration: No additional environment variables required beyond standard credential setup.

Troubleshooting

  • Invalid Credentials:
    Error Message: "Invalid authentication" or similar.
    Resolution: Ensure your QContact API credentials are correct and have sufficient permissions.

  • Malformed JSON (when 'As JSON' is enabled):
    Error Message: "Invalid JSON" or parsing errors.
    Resolution: Double-check the syntax of your JSON input.

  • No Results Returned:
    Possible Causes: Overly restrictive filter conditions, incorrect field names, or empty dataset.
    Resolution: Review your filter conditions and ensure the target entity contains matching records.

  • Unknown Field or Operator:
    Error Message: "Field not found" or "Unsupported operator."
    Resolution: Verify that the field names and operators used in conditions match those supported by the QContact API and the selected entity.

Links and References

Discussion