QContact icon

QContact

Consume QContact API (v.0.1.3)

Actions7

Overview

The "QContact" node for n8n allows users to interact with the QContact API, specifically to search for entities based on a query. This is useful in scenarios where you need to retrieve information about contacts, organizations, or other entity types managed within QContact. For example, you might use this node to look up customer records matching certain criteria and then process or route that data further in your workflow.

Properties

Name Type Meaning
Entity options The type of entity to search for (e.g., Contact, Organization). Options are dynamically loaded.
Query string The search query used to filter entities. This could be a name, email, or any supported search term.

Output

  • The node outputs a JSON object (or array of objects) representing the entities found by the search.
  • Each output item contains fields corresponding to the entity's properties as returned by the QContact API.
  • If binary data is ever returned (unlikely for a search operation), it would represent file attachments or similar resources associated with an entity.

Dependencies

  • External Service: Requires access to the QContact API.
  • API Key/Credentials: You must configure the qContactApi credentials in n8n.
  • n8n Configuration: Ensure the QContact node is installed and properly configured with valid credentials.

Troubleshooting

  • Invalid Credentials: If the API key or credentials are incorrect, the node will fail authentication. Double-check your qContactApi credentials in n8n.
  • No Results Found: If your query does not match any entities, the output will be an empty array. Adjust your query parameters.
  • Connection Errors: Network issues or incorrect API endpoints can cause connection failures. Verify network connectivity and endpoint configuration.
  • Common Error Messages:
    • "Authentication failed": Check your API credentials.
    • "Entity type not found": Ensure the selected entity type exists in your QContact instance.
    • "Invalid query": Review the syntax and content of your search query.

Links and References

  • n8n Documentation
  • QContact API documentation (refer to your organization's QContact API reference for details)

Discussion