Overview

This node operation allows searching for a contact within the Superchat platform by specifying a search field and a corresponding value. It supports searching by email address, phone number, or Instagram handle. This is useful for scenarios where you need to find contact details based on known identifiers, such as retrieving a contact's information by their email or phone number.

Use Case Examples

1. Search for a contact by their email address to retrieve their profile information.
2. Find a contact using their phone number to check their conversation history.
3. Lookup a contact by their Instagram handle to gather social media related details.

Properties

Output

JSON

• id - Unique identifier of the found contact
• name - Name of the contact
• email - Email address of the contact
• phone - Phone number of the contact
• instagram - Instagram handle of the contact
• additionalAttributes - Any additional custom attributes associated with the contact

Dependencies

• Superchat API key credential required for authentication to access contact data.

Troubleshooting

• Ensure the search field and value are correctly specified; incorrect or empty values may result in no contacts found.
• If the node throws authentication errors, verify that the Superchat API key credential is correctly configured and has the necessary permissions.
• Network or API errors may occur; check connectivity and API status if unexpected failures happen.

Links

• Superchat API Documentation - Official documentation for Superchat API, useful for understanding available endpoints and data structures.