Actions20
Overview
This node integrates with the Consultorio Live API to manage clinic and medical office operations. Specifically, for the "Agendamento" (Appointment) resource with the "Get Many" operation, it retrieves multiple appointment records based on specified search parameters. This is useful for scenarios where users want to fetch a list of appointments filtered by date ranges, patient or professional IDs, or appointment status.
Practical examples include:
- Fetching all scheduled appointments within a specific date range.
- Retrieving confirmed appointments for a particular patient.
- Listing cancelled or completed appointments for reporting or follow-up purposes.
Properties
| Name | Meaning |
|---|---|
| Parâmetros De Busca | Collection of search parameters to filter appointments: |
| - Data Fim | End date/time for the search interval. |
| - Data Início | Start date/time for the search interval. |
| - ID Do Paciente | Filter appointments by a specific patient ID. |
| - ID Do Profissional | Filter appointments by a specific professional ID. |
| - Status | Appointment status filter with options: "Agendado" (Scheduled), "Confirmado" (Confirmed), "Cancelado" (Cancelled), "Concluído" (Completed). Default is "Agendado". |
Output
The node outputs JSON data containing an array of appointment objects matching the search criteria. Each object represents an appointment with details as provided by the Consultorio Live API. The exact structure depends on the API response but typically includes fields like appointment ID, patient info, professional info, date/time, and status.
No binary data output is indicated.
Dependencies
- Requires connection to the Consultorio Live API.
- Needs an API authentication credential configured in n8n (an API key or token).
- The base URL for the API is taken from the credential configuration.
Troubleshooting
- Common issues:
- Invalid or missing API credentials will cause authentication errors.
- Incorrect date formats in the search parameters may lead to request failures.
- Filtering by non-existent patient or professional IDs will return empty results.
- Error messages:
- Authentication errors: Verify that the API key/token is correctly set up.
- Validation errors: Ensure date fields are properly formatted and required parameters are provided.
- Empty responses: Confirm that the filters match existing appointments.
Links and References
- Consultorio Live API documentation (refer to official docs for detailed endpoint and parameter descriptions).
- n8n documentation on creating and using API credentials.