ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Agents → Get Account Agents

AI-generated

Overview

This node interacts with the ChatWoot API to retrieve agents associated with a specific account. The "Get Account Agents" operation fetches all agents linked to the given numeric account ID. This is useful in scenarios where you want to manage or analyze the agents working under a particular account, such as displaying agent lists, monitoring agent activity, or integrating agent data into other workflows.

Practical examples include:

  • Automatically fetching and listing all agents for an account to assign tickets.
  • Synchronizing agent information with external CRM or support tools.
  • Generating reports on agent availability or performance.

Properties

Name Meaning
Account Id The numeric ID of the account to query.

Output

The node outputs JSON data containing the list of agents associated with the specified account. Each agent's details are included in the output JSON, typically including identifiers, names, roles, and status within the account.

If the API supports it, binary data is not expected from this operation since it deals with agent metadata.

Dependencies

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

Troubleshooting

  • Invalid Account Id: If the provided account ID does not exist or is incorrect, the API may return an error or empty results. Verify the account ID before running the node.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key/token is correctly configured.
  • Network Issues: Connectivity problems to the ChatWoot server can cause timeouts or request failures. Check network access and endpoint availability.
  • API Rate Limits: Excessive requests might trigger rate limiting by the ChatWoot API. Implement retry logic or reduce request frequency if needed.

Links and References

Discussion