Actions26
Overview
The node integrates with the Dental Office Cloud API to manage patient (Paciente) data. Specifically, the "Listar" operation under the "Paciente" resource allows users to retrieve a list of patients with various filtering and pagination options.
This node is beneficial in scenarios where dental clinics or offices want to automate fetching patient lists for reporting, synchronization with other systems, or workflow automation within n8n. For example, a clinic could use this node to regularly pull active patients from their system and update a CRM or send reminders.
Properties
| Name | Meaning |
|---|---|
| Buscar por Nome | Search patients by name (string filter). |
| Página | Page number for pagination (number). |
| ID da Clínica | Clinic ID to filter patients belonging to a specific clinic (number). |
| Status Ativo | Filter by patient's active status; options are: Ativo (true), Inativo (false), Ambos (both). |
| Apenas Excluídos | Boolean flag to list only deleted patients. |
Output
The output is an array of JSON objects representing patients retrieved from the Dental Office Cloud API. Each object contains patient details as returned by the API endpoint /v1/customers. The structure typically includes patient identifiers, names, clinic associations, status, and other relevant patient attributes.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authenticating requests to the Dental Office Cloud API.
- The node uses the internal helper function
dentalOfficeApiRequestto perform HTTP GET requests to the/v1/customersendpoint with query parameters based on input properties. - No additional external dependencies beyond the Dental Office Cloud API and its authentication.
Troubleshooting
- Invalid JSON format errors: Some properties accept JSON strings (e.g., addressesAttributes in other operations). While not directly used in "Listar," if extended, ensure JSON inputs are valid to avoid parsing errors.
- API request failures: Errors may occur due to invalid credentials, network issues, or incorrect parameter values. Verify API keys and parameter correctness.
- Empty results: If filters are too restrictive (e.g., searching by a name that does not exist or filtering only deleted patients when none exist), the output will be empty.
- Pagination issues: Ensure the page number is valid and within the range of available pages to get meaningful results.
Links and References
- Dental Office Cloud API Documentation (hypothetical link, replace with actual if available)
- n8n Documentation on Creating Custom Nodes
- General REST API usage best practices for pagination and filtering