Easy!Appointments icon

Easy!Appointments

Interact with Easy!Appointments API

Actions21

Overview

This node interacts with the Easy!Appointments API to manage provider records. Specifically, the "Get Many" operation for the "Provider" resource retrieves multiple provider entries from the system. This is useful when you want to list all providers or a subset based on certain criteria.

Common scenarios include:

  • Fetching a list of all service providers in an appointment scheduling system.
  • Retrieving providers with specific attributes or related data for reporting or integration purposes.
  • Using the provider data downstream in workflows, such as sending notifications or generating schedules.

Example: You might use this node to get all providers and then filter or process them in subsequent workflow steps.

Properties

Name Meaning
Return All Whether to return all provider records or limit the number of results returned.
Limit The maximum number of provider records to return (used only if "Return All" is false).
Additional Fields Optional parameters to customize the response:
- Fields Comma-separated list of specific fields to include in the response.
- Include Related Comma-separated list of related data to include in the response.
- Sort Field by which to sort results; prefix with "-" for descending order.
- Search Query Search term to filter providers by matching text.

Output

The output is a JSON array where each item represents a provider record retrieved from Easy!Appointments. Each provider object contains fields corresponding to the provider's details such as first name, last name, email, phone, services offered, address, city, ZIP code, notes, timezone, language, privacy status, and settings.

No binary data is output by this node.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the Easy!Appointments API.
  • The base URL for the Easy!Appointments instance must be set in the credentials.
  • The node uses HTTP requests to communicate with the Easy!Appointments REST API endpoints.

Troubleshooting

  • Invalid API credentials or base URL: The node will fail to connect if the API key or base URL is incorrect. Verify your credentials configuration.
  • Malformed JSON in additional fields (not applicable here but relevant for other operations): If you provide JSON strings in fields like "settings," ensure they are valid JSON.
  • Empty or no results: If no providers match the query or filters, the output will be an empty array.
  • Limit vs Return All: Setting "Return All" to false but not specifying a reasonable "Limit" may result in fewer results than expected.

Links and References

Discussion