Dental Office icon

Dental Office

Integração com a API do Dental Office Cloud

Actions26

Overview

This node integrates with the Dental Office Cloud API to manage users within a dental office system. Specifically, the "Usuário" (User) resource with the "Listar" (List) operation allows you to retrieve a list of users filtered by name, user group, and paginated by page number.

Common scenarios for this node include:

  • Fetching a filtered list of users by their names or user groups.
  • Paginating through large sets of users to process or display them in batches.
  • Integrating user data retrieval into automated workflows for reporting, synchronization, or notifications.

For example, you could use this node to get all users whose names contain "Maria" in a specific user group and process each user record further downstream in your workflow.

Properties

Name Meaning
Buscar por Nome (q) Search users by name. Enter a string to filter users whose names match or contain this value.
Grupo de Usuário (userGroup) Filter users by the ID of their user group. Provide a numeric ID to limit results to that group.
Página (page) Page number for pagination. Defaults to 1. Use this to navigate through multiple pages of results.

Output

The output is an array of JSON objects, each representing a user retrieved from the Dental Office Cloud API. Each object contains user details as returned by the API's /v1/users endpoint.

The structure of each JSON object corresponds directly to the user data model defined by the API, typically including fields such as user ID, name, email, user group, and other relevant attributes.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests against the Dental Office Cloud API.
  • The node uses the internal helper function dentalOfficeApiRequest to perform HTTP GET requests to the /v1/users endpoint.
  • Proper network access to the Dental Office Cloud API is necessary.

Troubleshooting

  • Invalid API credentials or missing authentication: The node will fail if the API key credential is not set up correctly or has expired. Ensure valid credentials are configured.
  • Invalid parameter types: For example, providing a non-numeric value for "Grupo de Usuário" or "Página" may cause errors. Validate input types before execution.
  • Empty or no results: If filters are too restrictive (e.g., a user group ID that does not exist), the node may return an empty array. Adjust filters accordingly.
  • API rate limits or connectivity issues: Network problems or API throttling can cause request failures. Check network connectivity and API usage limits.

Links and References

Discussion