QContact icon

QContact

Consume QContact API (v.0.1.3)

Actions7

Overview

The QContact node's "Entities: List" operation allows users to retrieve a list of entities from the QContact API. This is useful for scenarios where you need to fetch and process collections of records (such as contacts, companies, or other custom entities) managed within QContact. Typical use cases include synchronizing entity data with other systems, generating reports, or automating workflows based on entity lists.

Practical examples:

  • Fetching all contacts to send personalized emails.
  • Listing companies for CRM synchronization.
  • Retrieving a filtered set of entities for analytics or reporting.

Properties

Name Type Meaning
Entity options The type of entity to list (e.g., Contact, Company). Options are dynamically loaded from the API.
Simplify boolean Whether to return a simplified version of the response instead of the raw data.
Optional Params collection Additional parameters to refine the listing. See below for details.

Optional Params sub-properties:

Name Type Meaning
Sort Field options Field by which to sort results. Options depend on the selected entity type.
Sort Direction options Direction to sort results: Ascending or Descending.
Page number The page number to retrieve (for pagination).
Limit number Maximum number of results per page.
View string The name of the ListView to use. If not provided, only id, icon, and label are returned.

Output

  • The output is an array of JSON objects, each representing an entity record.
  • If Simplify is enabled, the output contains a streamlined structure with essential fields.
  • If Simplify is disabled, the output includes the full raw data as returned by the QContact API.
  • When a specific View is not specified, each entity object will contain at least id, icon, and label fields.

Example output (simplified):

[
  {
    "id": "123",
    "icon": "contact",
    "label": "John Doe"
  },
  {
    "id": "124",
    "icon": "contact",
    "label": "Jane Smith"
  }
]

Dependencies

  • External Service: Requires access to the QContact API.
  • API Key/Credentials: Needs valid QContact API credentials configured in n8n under the name qContactApi.
  • n8n Configuration: No special environment variables required beyond standard credential setup.

Troubleshooting

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

  • Entity Type Not Listed:
    Possible cause: The "Entity" dropdown is empty or missing expected types.
    Resolution: Check API connectivity and permissions; ensure the load options method is functioning.

  • No Results Returned:
    Possible cause: Filters (like View, Page, or Limit) may be too restrictive.
    Resolution: Adjust optional parameters or remove filters to broaden the search.

  • API Rate Limits or Errors:
    Error message: "Too many requests" or HTTP 429/500 errors.
    Resolution: Reduce request frequency or check QContact API status.

Links and References

Discussion