Actions113
- Accounts Actions
- Account Users 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
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
Overview
This node interacts with the Conversations resource of a chat or messaging platform, specifically to list conversations based on various filters. It is useful for retrieving conversation threads from an account, allowing users to programmatically access and manage conversations such as customer support chats or team discussions.
Common scenarios include:
- Fetching all open conversations assigned to a specific user or team.
- Filtering conversations by status (open, resolved, pending, snoozed).
- Searching conversations containing specific keywords.
- Paginating through large sets of conversations.
For example, a support team could use this node to automatically retrieve all unresolved conversations assigned to them for follow-up.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account to fetch conversations from. |
| Assignee Type | Filter conversations by assignee type. Options: Me, Unassigned, All, Assigned. |
| Status | Filter conversations by their status. Options: Open, Resolved, Pending, Snoozed. |
| Q | Search term to filter conversations containing messages with this text. |
| Inbox Id | Numeric ID of the inbox to filter conversations by. |
| Team Id | Numeric ID of the team to filter conversations by. |
| Labels | JSON array of labels to filter conversations by associated tags or categories. |
| Page | Page number for paginating through conversations. |
Output
The node outputs a JSON array of conversation objects matching the specified filters. Each object represents a conversation thread with details such as participants, status, assignee, messages summary, timestamps, and labels.
If binary data is present in the conversation (e.g., attachments), it would be included accordingly, but this node primarily focuses on JSON data representing conversation metadata.
Dependencies
- Requires an API key credential for authenticating with the chat platform's API.
- Needs the base URL of the chat service configured in credentials.
- Depends on the platform's Conversations API endpoint supporting query parameters for filtering and pagination.
Troubleshooting
- Invalid Account Id: Ensure the provided account ID exists and is numeric.
- Authentication Errors: Verify that the API key credential is valid and has necessary permissions.
- Empty Results: Check filter criteria; overly restrictive filters may return no conversations.
- Pagination Issues: If many conversations exist, ensure the page number is correctly incremented to retrieve subsequent results.
- Malformed Labels JSON: Confirm that the labels property contains valid JSON array syntax.
Links and References
- Chat platform API documentation for Conversations endpoint (generic link placeholder):
https://docs.chatplatform.com/api/conversations - n8n documentation on using API credentials:
https://docs.n8n.io/credentials/ - JSON formatting guide:
https://www.json.org/json-en.html