Actions14
Overview
This node integrates with the "Gestor Clientes Max" API, providing comprehensive management of clients, appointments, and financial accounts. Specifically for the Cliente (Client) - Search operation, it allows users to search for clients using a query term that can match client name, email, or phone number.
Common scenarios where this node is beneficial include:
- Quickly finding client details based on partial information.
- Filtering clients dynamically in workflows based on user input or other data.
- Automating client lookups before performing further operations like updating or scheduling appointments.
For example, a user could enter a search term such as "john@example.com" or "555-1234" to retrieve matching clients from the system.
Properties
| Name | Meaning |
|---|---|
| Search Query | Term used to search clients by name, email, or phone number. Example: "john", "email@example.com", or "123456789". |
Output
The output is a JSON object containing the search results returned by the API. This typically includes an array of client objects matching the search criteria, each with client details such as ID, name, email, phone, and possibly other metadata.
No binary data is output by this operation.
Example output structure (simplified):
[
{
"id": 123,
"name": "John Doe",
"email": "john@example.com",
"phone": "555-1234",
"cpf": "000.000.000-00"
},
{
"id": 124,
"name": "Jane Smith",
"email": "jane@example.com",
"phone": "555-5678"
}
]
Dependencies
- Requires an API key credential for authenticating with the Gestor Clientes Max API.
- The node uses HTTP requests to communicate with the API endpoint configured in the credentials.
- The base URL and API key must be set up correctly in the node's credential configuration.
Troubleshooting
- Empty or no results: Ensure the search query is not empty and matches existing client data. The search is case-insensitive but depends on the API's indexing.
- Authentication errors: Verify that the API key credential is valid and has necessary permissions.
- Network issues: Confirm that the API base URL is reachable from the n8n environment.
- Unknown operation error: This indicates a misconfiguration of the resource or operation parameters; ensure "client" resource and "search" operation are selected.
- Malformed query parameter: Special characters in the search query should be URL-encoded automatically, but if issues arise, check the input format.
Links and References
- Gestor Clientes Max API Documentation (Note: Replace with actual API docs link if available)
- n8n HTTP Request Node documentation: https://docs.n8n.io/nodes/n8n-nodes-base.httpRequest/