Kuantia CRM icon

Kuantia CRM

Interact with Kuantia CRM API

Actions65

Contacts → Contact Controller Search Get

AI-generated

Overview

This node operation allows searching and retrieving contacts from the Kuantia CRM system with various filtering, sorting, and pagination options. It is useful for scenarios where users need to query contacts based on specific criteria such as tags, custom fields, or text search across multiple fields like name, email, and phone. For example, a user can fetch a paginated list of contacts tagged as 'urgent' and sorted by creation date.

Use Case Examples

  1. Retrieve the first page of contacts with a limit of 10 items per page, including related company information.
  2. Search contacts with the text 'john doe' across name, email, and phone fields, filtering only unread conversations.
  3. Sort contacts by custom field 'priority' and group results by custom field 'status'.
  4. Filter contacts by tags such as 'urgent', 'customer-support', and 'follow-up'. Potentially use custom field filters and search within custom fields.

Properties

Name Meaning
Page Page number for paginated results (1-based). Controls which page of results to retrieve.
Limit Number of items to return per page. Controls the size of each page of results.
Relations Relations to include in the response, supporting nested relations via dot notation. Allows fetching related entities like company and company accounts.
Select Fields to select in the response. Specifies which contact fields to include in the output.
Sort Sort configuration for the results. Can specify one or multiple fields with order (e.g., descending by creation date).
Filters Filter conditions as a JSON object to narrow down the contacts returned.
Custom Field Filters Filter contacts by custom field values using JSON path queries.
Custom Field Search Search text within custom field values to find matching contacts.
Search Search text across name, email, and phone fields to find matching contacts.
Tags Filter contacts by tags. Returns contacts that contain any of the specified tags.
Custom Field Sort Sort contacts by a custom field specified in the format customFields.fieldName.
Custom Field Group By Group contacts by a custom field specified in the format customFields.fieldName.
Show Unread Only Boolean filter to show only unread conversations related to contacts.
Current User Id Current user ID used for filtering 'mine' conversations in count queries.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • id - Unique identifier of the contact.
  • email - Email address of the contact.
  • firstName - First name of the contact.
  • lastName - Last name of the contact.
  • company - Related company information included if specified in relations.
  • accounts - Accounts related to the company, included if specified in relations.
  • tags - Tags associated with the contact.
  • customFields - Custom field values associated with the contact.

Dependencies

  • Kuantia CRM API with authentication token

Troubleshooting

  • Ensure the API credentials (URL and token) are correctly configured to avoid authentication errors.
  • Verify that the JSON format for filters, customFieldFilters, relations, select, sort, and tags is valid to prevent request failures.
  • If using proxy or SSL options, confirm the settings are correct to avoid connection issues.
  • Timeout errors may occur if the server is slow to respond; adjust the timeout setting accordingly.

Links

Discussion