Easy!Appointments

Consume Easy!Appointments API

Actions38

Overview

The Secretary - Get Many operation in the Easy!Appointments n8n node retrieves a list of secretaries from an Easy!Appointments instance. This is useful for automating workflows that need to access, filter, or process information about multiple secretary records at once.

Common scenarios:

  • Listing all secretaries for administrative dashboards.
  • Filtering secretaries by provider for reporting or notification purposes.
  • Paginating through large sets of secretary data for synchronization with other systems.

Practical examples:

  • Fetching all secretaries who manage a specific provider.
  • Retrieving a paginated and sorted list of secretaries for display in a custom UI.
  • Searching for secretaries using a query string.

Properties

Name Type Meaning
Page Number Page number for pagination (default: 1).
Length Number Number of results per page (default: 10).
Sort String Sort field and direction, e.g., "id asc".
Query String Search query to filter secretaries by name or other attributes.
Provider ID String Filter secretaries by the ID of the provider they manage.

Output

The output is a JSON array where each item represents a secretary object as returned by the Easy!Appointments API. The structure typically includes fields such as:

{
  "id": 123,
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com",
  "phone": "1234567890",
  "mobile": "0987654321",
  "address": "123 Main St",
  "city": "Sample City",
  "state": "State",
  "zip": "12345",
  "notes": "Some notes",
  "timezone": "Europe/Berlin",
  "settings": "{...}",
  "calendarView": "{...}",
  "providers": "1,2,3"
}

Note: The actual fields may vary depending on your Easy!Appointments setup and API version.

Dependencies

  • External Service: Requires access to an Easy!Appointments server with its REST API enabled.
  • Authentication: Needs valid credentials (username, password, and base URL) configured in n8n under the easyAppointmentsApi credential type.

Troubleshooting

Common issues:

  • Invalid Credentials: If the username, password, or base URL are incorrect, authentication will fail.
  • Missing Base URL: The node requires a non-empty base URL; otherwise, it throws "Base URL is required".
  • API Connectivity: Network issues or incorrect API endpoints can cause connection errors.
  • No Results: If filters are too restrictive, the result may be an empty array.

Error messages:

  • "Base URL is required": Ensure the Easy!Appointments API URL is set correctly in credentials.
  • Authentication errors: Double-check username and password.
  • Other errors: The error message from the API will be included in the output if "Continue On Fail" is enabled.

Links and References

Discussion