Actions14
Overview
This node integrates with the "Gestor Clientes Max" API to manage clients, appointments, and financial accounts. Specifically for the Cliente (Client) resource with the Get By ID operation, it retrieves detailed information about a single client by their unique ID.
Common scenarios where this node is beneficial include:
- Fetching client details to display or process in workflows.
- Integrating client data retrieval into automated processes such as CRM updates, notifications, or reporting.
- Using client information to link with other resources like appointments or financial records.
Practical example:
- You have a workflow triggered by a new appointment booking, and you want to fetch the client's full profile by their ID to personalize communications or update external systems.
Properties
| Name | Meaning |
|---|---|
| Client ID | The unique numeric identifier of the client to retrieve. This is required for operations that target a specific client such as Get By ID, Update, or Delete. |
Output
The node outputs JSON data representing the client object returned by the API. This typically includes all client details such as name, email, phone, CPF (tax ID), and any other fields provided by the Gestor Clientes Max API for a client.
No binary data output is produced by this operation.
Example output structure (simplified):
{
"id": 123,
"name": "John Doe",
"email": "john.doe@example.com",
"phone": "+5511999999999",
"cpf": "123.456.789-00"
}
Dependencies
- Requires an API key credential for authenticating with the Gestor Clientes Max API.
- The node expects the API base URL and API key to be configured in the credentials.
- Network access to the Gestor Clientes Max API endpoint is necessary.
Troubleshooting
Common issues:
- Invalid or missing Client ID parameter will cause the request to fail.
- Incorrect or expired API key will result in authentication errors.
- Network connectivity problems can prevent successful API calls.
- If the client ID does not exist, the API may return a 404 error.
Error messages:
"Unknown operation: client.get": Indicates the operation name was not recognized; ensure the operation is correctly set to "Get By ID".- HTTP errors from the API (e.g., 401 Unauthorized, 404 Not Found) should be checked against the API documentation and credentials.
Resolution tips:
- Verify the Client ID is correct and exists in the system.
- Confirm the API key credential is valid and has proper permissions.
- Check network connectivity and API endpoint availability.
- Enable "Continue On Fail" in the node settings if you want the workflow to proceed despite individual errors.
Links and References
- Gestor Clientes Max API Documentation (Replace with actual API docs URL if available)
- n8n Documentation on Creating Custom Nodes
- General REST API best practices for troubleshooting HTTP errors