Kuantia CRM icon

Kuantia CRM

Interact with Kuantia CRM API

Actions65

Conversations → Conversation Controller Search

AI-generated

Overview

This node operation performs a search query on conversations within the Kuantia CRM system. It allows users to filter, sort, paginate, and customize the data retrieved about conversations, including related entities and custom fields. This is useful for scenarios where users need to find specific conversations based on various criteria such as tags, custom field values, or text search across multiple fields.

Use Case Examples

  1. Searching for conversations related to a specific company and filtering by tags like 'urgent' or 'customer-support'.
  2. Retrieving a paginated list of conversations sorted by creation date, including related company and account information.
  3. Filtering conversations to show only unread ones assigned to the current user.

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 using dot notation. Allows fetching related entities like company and accounts.
Select Fields to select in the response. Specifies which conversation fields to include in the output.
Sort Sort configuration for the results. Can specify one or multiple fields and their order (e.g., ascending or descending).
Filters Filter conditions as a JSON object to narrow down the conversations returned based on field values.
Custom Field Filters Filter conversations by custom field values using JSON path queries. Supports complex queries like $in, $contains, $gte, $gt, and $exists.
Custom Field Search Search text within custom field values to find conversations matching specific custom data.
Search Search text across standard fields such as name, email, and phone to find matching conversations.
Tags Filter conversations by tags. Returns 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 Boolean filter to show only unread conversations.
Current User Id Current user ID used for filtering conversations assigned to the user 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 conversation.
  • email - Email associated with the conversation.
  • firstName - First name of the contact in the conversation.
  • lastName - Last name of the contact in the conversation.
  • company
    • accounts - Accounts related to the company, included based on relations property.
  • customFields - Custom field values associated with the conversation.
  • tags - Tags assigned to the conversation.
  • createdAt - Timestamp when the conversation was created.

Dependencies

  • An API key credential for Kuantia CRM to authenticate requests.

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access conversation data.
  • Verify that JSON inputs for filters, relations, select, sort, tags, and custom field filters are properly formatted to avoid parsing errors.
  • If the request times out, consider increasing the timeout setting or checking network connectivity.
  • If SSL certificate validation fails and you trust the endpoint, enable the option to ignore SSL issues.
  • Check that the currentUserId is correctly set when filtering conversations assigned to a specific user.

Discussion