Easy!Appointments

Consume Easy!Appointments API

Actions38

Overview

The Easy!Appointments n8n node allows you to interact with the Easy!Appointments API for automating appointment management tasks. Specifically, the Secretary → Create operation enables you to create a new secretary profile in your Easy!Appointments system. This is useful for organizations that need to programmatically onboard secretaries, manage their access, or synchronize HR systems with Easy!Appointments.

Practical scenarios:

  • Automatically add new secretaries when onboarding staff.
  • Integrate HR workflows to keep secretary records up-to-date.
  • Assign secretaries to manage specific providers via automation.

Properties

Name Type Meaning
Additional Fields Collection A group of optional fields to define the secretary's details. See below for subfields.

Subfields of "Additional Fields":

Name Type Meaning
First Name String First name of the secretary
Last Name String Last name of the secretary
Email String Email address of the secretary
Phone String Phone number of the secretary
Mobile String Mobile number of the secretary
Address String Physical address of the secretary
City String City where the secretary is located
State String State/region of the secretary
ZIP String ZIP/postal code
Notes String Any notes about the secretary
Timezone String Timezone of the secretary
Settings String Secretary settings in JSON format
Calendar View String Calendar view settings in JSON format
Providers String Comma-separated list of provider IDs this secretary can manage

Output

  • The output will be a JSON object representing the newly created secretary as returned by the Easy!Appointments API.
  • The structure typically includes all the fields provided in the request, along with additional metadata such as the generated ID and timestamps (if supported by the API).

Example output:

{
  "id": "123",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com",
  "phone": "+1234567890",
  "mobile": "+0987654321",
  "address": "123 Main St",
  "city": "Metropolis",
  "state": "State",
  "zip": "12345",
  "notes": "New hire",
  "timezone": "Europe/Berlin",
  "settings": "{\"notifications\":true}",
  "calendarView": "{\"view\":\"week\"}",
  "providers": "1,2,3"
}

Note: Actual output fields depend on the API response.

Dependencies

  • External Service: Requires access to an Easy!Appointments instance with API enabled.
  • API Credentials: You must configure the easyAppointmentsApi credential in n8n, including:
    • Base URL (e.g., https://your-easyappointments-instance/api/v1)
    • Username
    • Password

Troubleshooting

Common issues:

  • Missing or invalid credentials: If the API credentials are not set or incorrect, authentication errors will occur.
  • Base URL not set: The node requires a valid base URL; if missing, it throws "Base URL is required".
  • Invalid field values: Providing improperly formatted JSON in "Settings" or "Calendar View" may result in API errors.
  • Insufficient permissions: The user account used for API access must have permission to create secretaries.

Error messages:

  • "Base URL is required": Ensure the Easy!Appointments API URL is correctly set in the credentials.
  • Authentication errors (e.g., 401 Unauthorized): Check username and password.
  • Validation errors from the API: Review the input fields for correct formatting and required data.

Links and References

Discussion