Actions115
- Teams Actions
- Account Users Actions
- Custom Attributes Actions
- Contacts Actions
- Conversation Labels Actions
- Reports Actions
- Accounts Actions
- Contact Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Messages Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Inboxes Actions
- Integrations Actions
- Profile Actions
- Custom Filters Actions
- Webhooks Actions
Overview
This node performs a contact search within the 'Contacts' resource of the Konverte Digital API. It allows users to search for contacts by various attributes such as name, identifier, email, or phone number, and supports sorting and pagination of the results. This node is useful for scenarios where you need to retrieve specific contact information from an account, for example, to integrate contact data into a CRM workflow or to automate contact management tasks.
Use Case Examples
- Search contacts by name or email to find specific individuals in an account.
- Retrieve a sorted list of contacts by last activity date for follow-up actions.
- Paginate through contacts in batches to process large contact lists efficiently.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account to search contacts within. This is a required field to specify the account context for the search. |
| Q | The search query string used to find contacts by name, identifier, email, or phone number. |
| Sort | The attribute by which the contact list should be sorted. Options include name, email, phone number, and last activity date, with ascending or descending order. |
| Page | The page number of the results to retrieve, used for pagination. |
| Request Options | Additional request settings including batching (to throttle requests), SSL certificate validation bypass, proxy configuration, and request timeout settings. |
Output
JSON
contacts- Array of contact objects returned from the search query, containing contact details matching the search criteria.pagination- Pagination information including current page, total pages, and items per page.
Dependencies
- Requires an API key credential for authentication with the Konverte Digital API.
Troubleshooting
- Ensure the 'Account Id' is correctly specified and exists in the system to avoid empty or error responses.
- Check network connectivity and proxy settings if requests fail or time out.
- If SSL certificate validation errors occur, consider enabling the 'Ignore SSL Issues' option cautiously.
- Verify that the API key credential is valid and has sufficient permissions to perform contact searches.
Links
- Konverte Digital API Documentation - Contacts - Official API documentation for managing and searching contacts in Konverte Digital.