ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Contacts API → Get Details Of A Contact

AI-generated

Overview

This node interacts with the Contacts API of ChatWoot to retrieve detailed information about a specific contact. It is useful when you need to fetch up-to-date data on a contact, such as their profile details or status, based on identifiers obtained from previous API calls or integrations.

Common scenarios include:

  • Fetching contact details for display in dashboards or CRM systems.
  • Synchronizing contact information between ChatWoot and other platforms.
  • Automating workflows that depend on contact attributes or statuses.

For example, after creating a contact via the API, you can use this node to get the full details of that contact by providing the inbox and contact identifiers.

Properties

Name Meaning
Inbox Identifier The unique identifier of the inbox channel where the contact exists.
Contact Identifier The unique source ID of the contact, obtained when the contact was created previously.

Output

The node outputs JSON data containing the detailed information of the specified contact. This typically includes all available fields returned by the ChatWoot Contacts API for that contact, such as name, email, phone number, status, and any custom attributes.

If the API supports binary data related to contacts (e.g., profile pictures), the node would handle it accordingly, but based on the provided code and properties, the output focuses on JSON contact details.

Dependencies

  • Requires an active connection to the ChatWoot API.
  • Needs an API authentication token configured in the node credentials to authorize requests.
  • The base URL for the ChatWoot instance must be set in the credentials.

Troubleshooting

  • Missing or invalid identifiers: Ensure both the Inbox Identifier and Contact Identifier are correctly provided; otherwise, the API call will fail.
  • Authentication errors: Verify that the API key or token is valid and has sufficient permissions.
  • Network issues: Confirm that the ChatWoot instance URL is reachable from the n8n environment.
  • API changes: If the ChatWoot API updates its schema or endpoints, the node might require updates to remain compatible.

Common error messages may include unauthorized access, resource not found (if identifiers are incorrect), or bad request due to malformed inputs.

Links and References

Discussion