Kuantia CRM icon

Kuantia CRM

Interact with Kuantia CRM API

Actions65

Contacts → Contact Controller Search

AI-generated

Overview

This node performs a search operation on contacts within the Kuantia CRM system. It allows users to query contacts with various filters, sorting, pagination, and selection options. This is useful for retrieving specific contact information based on criteria such as company association, custom fields, tags, and text search across multiple fields like name, email, and phone.

Use Case Examples

  1. Retrieve a paginated list of contacts belonging to a specific company, including related company and account information.
  2. Search contacts by custom field values such as status or priority, and sort results by creation date.
  3. Filter contacts to show only those with specific tags or unread conversations.

Properties

Name Meaning
Page Page number for paginated results (1-based). Controls which page of results to retrieve.
Limit Number of items per page. Controls the size of each page of results.
Relations Relations to include in the response, supporting nested relations using dot notation.
Select Fields to select in the response, specifying which contact properties to return.
Sort Sort configuration for the results, allowing sorting by one or multiple fields.
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.
Search Search text across name, email, and phone fields.
Tags Filter contacts by tags, returning entities that contain any of the specified tags.
Custom Field Sort Sort results by a custom field using the format customFields.fieldName.
Custom Field Group By Group results by a custom field using the format customFields.fieldName.
Show Unread Only Filter to show only unread conversations.
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 of the contact.
  • accounts - Related accounts associated with the contact's company.

Dependencies

  • Kuantia CRM API key credential

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access contact data.
  • Verify that JSON inputs for filters, relations, select, sort, and custom field filters are properly formatted to avoid parsing errors.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If SSL certificate validation errors occur, consider enabling the option to ignore SSL issues, but be aware of security implications.

Discussion