Easy!Appointments
App · 11 actions
Run your Easy!Appointments bookings from workflows: find free times, book, reschedule, confirm or cancel appointments, find them by day or customer, and keep customers up to date. Start a workflow on a new, changed or canceled appointment.
Actions
| Action | What it does |
|---|---|
| Book appointment | Book a service with a provider for a customer, found by email or added. |
| Cancel appointment | Cancel an appointment, which deletes it as Easy!Appointments' own cancel does and emails the customer and provider. |
| Create or update customer | Update the customer with this email address, or add them if Easy!Appointments doesn't have them. |
| Find appointments | Find appointments by day, provider, service, customer email or status, soonest first. |
| Find customers | Find customers by name, email address or phone number, or list the newest. |
| Get appointment | Get an appointment with its time, status, service, provider and customer, and the customer's link to change it. |
| Get available times | Get the free times for a service on a day, with one provider or every provider who offers it, as the booking page shows them. |
| List providers | List the providers appointments are booked with, with their contact details, time zone and the services they offer. |
| List services | List the services customers can book, with their length, price, location and category. |
| Reschedule appointment | Move an appointment to a new time, and to another provider if asked, keeping its length. |
| Update appointment | Change an appointment's status (such as Confirmed), notes, location or video meeting link. |
Book appointment
Book a service with a provider for a customer, found by email or added. Checks the time is free first, as the booking page does.
Inputs
- Service
servicetextRequired - The service to book.
- Provider
providertextRequired - Who the appointment is with. They must offer the service.
- Start
startdate and timeRequired - When it starts. A time typed without a time zone, such as 2026-11-10 14:30 from 'Get available times', is the provider's.
- Customer email
emailtextRequired - The customer's email address. They're added as a customer if Easy!Appointments doesn't have them yet.
- First name
first_nametext - The customer's first name, if new.
- Last name
last_nametext - The customer's last name, if new.
- Phone
phonetext - The customer's phone number, if new. Easy!Appointments asks for one unless its Booking Settings say otherwise.
- Notes
notestext - Notes on the appointment, seen by the provider.
- Location
locationtext - Where it takes place. Defaults to the service's location.
- Status
statustext - The appointment's status. Defaults to the first, Booked.
- Only if the time is free
only_if_freetrue/false - Check the time is one of the provider's free times first, as the booking page does. Turn off to book it anyway, as staff can in the calendar.Default:
true.
Outputs
booked_attext- When it was booked, in Easy!Appointments' own time zone
calendar_urltext- The appointment in Easy!Appointments' calendar, for staff
customer_emailtext- The customer's email address
customer_first_nametext- The customer's first name
customer_idnumber- The customer's ID
customer_last_nametext- The customer's last name
customer_nametext- The customer's full name
customer_phonetext- The customer's phone number
datetext- The day it's on (2026-11-10)
duration_minutesnumber- How long it is, in minutes
endtext- When it ends, in the provider's time zone
ends_attext- When it ends, as ISO 8601 with the time zone's offset
idnumber- The appointment's ID, for the other Easy!Appointments steps
locationtext- Where it takes place
manage_urltext- The customer's page to reschedule or cancel it, as in their emails
meeting_linktext- Its video meeting link, if it has one
new_customertrue/false- Whether the customer was added for this booking
notestext- Its notes
provider_emailtext- The provider's email address
provider_idnumber- The provider's ID
provider_nametext- The provider's name
service_idnumber- The service's ID
service_nametext- The service, such as Consultation
starttext- When it starts, in the provider's time zone (2026-11-10 14:30)
starts_attext- When it starts, as ISO 8601 with the time zone's offset
statustext- Its status, such as Booked or Confirmed
timetext- The time it starts, on a 24-hour clock (14:30)
time_zonetext- The provider's time zone, such as America/New_York
Example output
{
"booked_at": "2026-11-05 19:36",
"calendar_url": "https://booking.example.com/index.php/calendar/reschedule/1sqcjHFVSi6Y",
"customer_email": "ada@example.com",
"customer_first_name": "Ada",
"customer_id": 6,
"customer_last_name": "Lovelace",
"customer_name": "Ada Lovelace",
"customer_phone": "+1 555 0101",
"date": "2026-11-10",
"duration_minutes": 30,
"end": "2026-11-10 15:00",
"ends_at": "2026-11-10T15:00:00-05:00",
"id": 42,
"location": "Riverside Clinic, 12 River St",
"manage_url": "https://booking.example.com/index.php/booking/reschedule/1sqcjHFVSi6Y",
"meeting_link": "",
"new_customer": true,
"notes": "First visit",
"provider_email": "maya.patel@example.com",
"provider_id": 4,
"provider_name": "Maya Patel",
"service_id": 2,
"service_name": "Consultation",
"start": "2026-11-10 14:30",
"starts_at": "2026-11-10T14:30:00-05:00",
"status": "Booked",
"time": "14:30",
"time_zone": "America/New_York"
}Cancel appointment
Cancel an appointment, which deletes it as Easy!Appointments' own cancel does and emails the customer and provider. Returns it as it was.
Inputs
- Appointment ID
appointmenttextRequired - The appointment's ID, from a trigger or an earlier step.
Outputs
booked_attext- When it was booked, in Easy!Appointments' own time zone
calendar_urltext- The appointment in Easy!Appointments' calendar, for staff
canceledtrue/false- Always true: the appointment was canceled, which deletes it
customer_emailtext- The customer's email address
customer_first_nametext- The customer's first name
customer_idnumber- The customer's ID
customer_last_nametext- The customer's last name
customer_nametext- The customer's full name
customer_phonetext- The customer's phone number
datetext- The day it's on (2026-11-10)
duration_minutesnumber- How long it is, in minutes
endtext- When it ends, in the provider's time zone
ends_attext- When it ends, as ISO 8601 with the time zone's offset
idnumber- The appointment's ID, for the other Easy!Appointments steps
locationtext- Where it takes place
manage_urltext- The customer's page to reschedule or cancel it, as in their emails
meeting_linktext- Its video meeting link, if it has one
notestext- Its notes
provider_emailtext- The provider's email address
provider_idnumber- The provider's ID
provider_nametext- The provider's name
service_idnumber- The service's ID
service_nametext- The service, such as Consultation
starttext- When it starts, in the provider's time zone (2026-11-10 14:30)
starts_attext- When it starts, as ISO 8601 with the time zone's offset
statustext- Its status, such as Booked or Confirmed
timetext- The time it starts, on a 24-hour clock (14:30)
time_zonetext- The provider's time zone, such as America/New_York
Example output
{
"booked_at": "2026-11-05 19:36",
"calendar_url": "https://booking.example.com/index.php/calendar/reschedule/1sqcjHFVSi6Y",
"canceled": true,
"customer_email": "ada@example.com",
"customer_first_name": "Ada",
"customer_id": 6,
"customer_last_name": "Lovelace",
"customer_name": "Ada Lovelace",
"customer_phone": "+1 555 0101",
"date": "2026-11-10",
"duration_minutes": 30,
"end": "2026-11-10 15:00",
"ends_at": "2026-11-10T15:00:00-05:00",
"id": 42,
"location": "Riverside Clinic, 12 River St",
"manage_url": "https://booking.example.com/index.php/booking/reschedule/1sqcjHFVSi6Y",
"meeting_link": "",
"notes": "First visit",
"provider_email": "maya.patel@example.com",
"provider_id": 4,
"provider_name": "Maya Patel",
"service_id": 2,
"service_name": "Consultation",
"start": "2026-11-10 14:30",
"starts_at": "2026-11-10T14:30:00-05:00",
"status": "Booked",
"time": "14:30",
"time_zone": "America/New_York"
}Create or update customer
Update the customer with this email address, or add them if Easy!Appointments doesn't have them. Only the fields filled in change.
Inputs
- Email
emailtextRequired - The customer's email address, which finds them.
- First name
first_nametext - Their first name.
- Last name
last_nametext - Their last name.
- Phone
phonetext - Their phone number.
- Address
addresstext - Their street address.
- City
citytext - Their city.
- Zip code
zip_codetext - Their zip or postal code.
- Notes
notestext - Notes about the customer.
- Time zone
time_zonetext - Their time zone, such as America/New_York, which their emails show times in.
Outputs
addresstext- Their street address
citytext- Their city
createdtrue/false- Whether the customer was added, not updated
emailtext- Their email address
first_nametext- Their first name
idnumber- The customer's ID
languagetext- The language of their emails, such as english
last_nametext- Their last name
nametext- Their full name
notestext- Notes about them
phonetext- Their phone number
time_zonetext- Their time zone, which their emails use
zip_codetext- Their zip or postal code
Example output
{
"address": "12 Analytical Way",
"city": "London",
"created": false,
"email": "ada@example.com",
"first_name": "Ada",
"id": 6,
"language": "english",
"last_name": "Lovelace",
"name": "Ada Lovelace",
"notes": "Prefers mornings",
"phone": "+1 555 0101",
"time_zone": "Europe/London",
"zip_code": "N1 9GU"
}Find appointments
Find appointments by day, provider, service, customer email or status, soonest first. With nothing to go on, lists the ones still to come.
Inputs
- From
date_fromdate - Only appointments starting on or after this day.
- To
date_todate - Only appointments ending on or before this day.
- Provider
providertext - Only this provider's appointments.
- Service
servicetext - Only appointments for this service.
- Customer email
customer_emailtext - Only this customer's appointments, past and future unless dates are given.
- Status
statustext - Only appointments with this status.
- How many
limitnumber - The most to list. Defaults to 25.From 1 to 500.
Outputs
appointmentslist- The appointments, soonest first
countnumber- How many were found
Example output
{
"appointments": [
{
"booked_at": "2026-11-05 19:36",
"calendar_url": "https://booking.example.com/index.php/calendar/reschedule/1sqcjHFVSi6Y",
"customer_email": "ada@example.com",
"customer_first_name": "Ada",
"customer_id": 6,
"customer_last_name": "Lovelace",
"customer_name": "Ada Lovelace",
"customer_phone": "+1 555 0101",
"date": "2026-11-10",
"duration_minutes": 30,
"end": "2026-11-10 15:00",
"ends_at": "2026-11-10T15:00:00-05:00",
"id": 42,
"location": "Riverside Clinic, 12 River St",
"manage_url": "https://booking.example.com/index.php/booking/reschedule/1sqcjHFVSi6Y",
"meeting_link": "",
"notes": "First visit",
"provider_email": "maya.patel@example.com",
"provider_id": 4,
"provider_name": "Maya Patel",
"service_id": 2,
"service_name": "Consultation",
"start": "2026-11-10 14:30",
"starts_at": "2026-11-10T14:30:00-05:00",
"status": "Booked",
"time": "14:30",
"time_zone": "America/New_York"
}
],
"count": 1
}Find customers
Find customers by name, email address or phone number, or list the newest.
Inputs
- Search
searchtext - A name, email address or phone number, or part of one. Leave blank for the newest customers.
- How many
limitnumber - The most to list. Defaults to 25.From 1 to 500.
Outputs
countnumber- How many were found
customerslist- The customers
Example output
{
"count": 1,
"customers": [
{
"address": "12 Analytical Way",
"city": "London",
"email": "ada@example.com",
"first_name": "Ada",
"id": 6,
"language": "english",
"last_name": "Lovelace",
"name": "Ada Lovelace",
"notes": "Prefers mornings",
"phone": "+1 555 0101",
"time_zone": "Europe/London",
"zip_code": "N1 9GU"
}
]
}Get appointment
Get an appointment with its time, status, service, provider and customer, and the customer's link to change it.
Inputs
- Appointment ID
appointmenttextRequired - The appointment's ID, from a trigger or an earlier step.
Outputs
booked_attext- When it was booked, in Easy!Appointments' own time zone
calendar_urltext- The appointment in Easy!Appointments' calendar, for staff
customer_emailtext- The customer's email address
customer_first_nametext- The customer's first name
customer_idnumber- The customer's ID
customer_last_nametext- The customer's last name
customer_nametext- The customer's full name
customer_phonetext- The customer's phone number
datetext- The day it's on (2026-11-10)
duration_minutesnumber- How long it is, in minutes
endtext- When it ends, in the provider's time zone
ends_attext- When it ends, as ISO 8601 with the time zone's offset
idnumber- The appointment's ID, for the other Easy!Appointments steps
locationtext- Where it takes place
manage_urltext- The customer's page to reschedule or cancel it, as in their emails
meeting_linktext- Its video meeting link, if it has one
notestext- Its notes
provider_emailtext- The provider's email address
provider_idnumber- The provider's ID
provider_nametext- The provider's name
service_idnumber- The service's ID
service_nametext- The service, such as Consultation
starttext- When it starts, in the provider's time zone (2026-11-10 14:30)
starts_attext- When it starts, as ISO 8601 with the time zone's offset
statustext- Its status, such as Booked or Confirmed
timetext- The time it starts, on a 24-hour clock (14:30)
time_zonetext- The provider's time zone, such as America/New_York
Example output
{
"booked_at": "2026-11-05 19:36",
"calendar_url": "https://booking.example.com/index.php/calendar/reschedule/1sqcjHFVSi6Y",
"customer_email": "ada@example.com",
"customer_first_name": "Ada",
"customer_id": 6,
"customer_last_name": "Lovelace",
"customer_name": "Ada Lovelace",
"customer_phone": "+1 555 0101",
"date": "2026-11-10",
"duration_minutes": 30,
"end": "2026-11-10 15:00",
"ends_at": "2026-11-10T15:00:00-05:00",
"id": 42,
"location": "Riverside Clinic, 12 River St",
"manage_url": "https://booking.example.com/index.php/booking/reschedule/1sqcjHFVSi6Y",
"meeting_link": "",
"notes": "First visit",
"provider_email": "maya.patel@example.com",
"provider_id": 4,
"provider_name": "Maya Patel",
"service_id": 2,
"service_name": "Consultation",
"start": "2026-11-10 14:30",
"starts_at": "2026-11-10T14:30:00-05:00",
"status": "Booked",
"time": "14:30",
"time_zone": "America/New_York"
}Get available times
Get the free times for a service on a day, with one provider or every provider who offers it, as the booking page shows them.
Inputs
- Service
servicetextRequired - The service to find a time for.
- Date
daydateRequired - The day to look at, in the providers' time zones.
- Provider
providertext - Only this provider's times. Leave blank for every provider who offers the service.
Outputs
countnumber- How many free times with a provider there are
datetext- The day asked about
duration_minutesnumber- How long the service is, in minutes
service_idnumber- The service's ID
service_nametext- The service
slotslist- Each free time with each provider, earliest first
timeslist- Every free time that day with any of the providers (09:30)
Example output
{
"count": 2,
"date": "2026-11-10",
"duration_minutes": 30,
"service_id": 2,
"service_name": "Consultation",
"slots": [
{
"end": "2026-11-10 09:30",
"provider_id": 4,
"provider_name": "Maya Patel",
"start": "2026-11-10 09:00",
"starts_at": "2026-11-10T09:00:00-05:00",
"time": "09:00",
"time_zone": "America/New_York"
},
{
"end": "2026-11-10 09:45",
"provider_id": 4,
"provider_name": "Maya Patel",
"start": "2026-11-10 09:15",
"starts_at": "2026-11-10T09:15:00-05:00",
"time": "09:15",
"time_zone": "America/New_York"
}
],
"times": [
"09:00",
"09:15"
]
}List providers
List the providers appointments are booked with, with their contact details, time zone and the services they offer.
Inputs
- Service
servicetext - Only providers who offer this service.
Outputs
countnumber- How many there are
providerslist- The providers, by last name
Example output
{
"count": 1,
"providers": [
{
"email": "maya.patel@example.com",
"first_name": "Maya",
"id": 4,
"last_name": "Patel",
"mobile": "",
"name": "Maya Patel",
"phone": "+1 555 0100",
"private": false,
"service_ids": [
2,
3
],
"services": [
"Consultation",
"Follow-up"
],
"time_zone": "America/New_York"
}
]
}List services
List the services customers can book, with their length, price, location and category.
Inputs
- Category
categorytext - Only this category's services.
Outputs
countnumber- How many there are
serviceslist- The services, by name
Example output
{
"count": 1,
"services": [
{
"attendants": 1,
"category": "Clinic",
"category_id": 1,
"currency": "USD",
"description": "First visit and assessment",
"duration_minutes": 30,
"id": 2,
"location": "Riverside Clinic, 12 River St",
"name": "Consultation",
"price": 60.0,
"private": false
}
]
}Reschedule appointment
Move an appointment to a new time, and to another provider if asked, keeping its length. Checks the new time is free first.
Inputs
- Appointment ID
appointmenttextRequired - The appointment's ID, from a trigger or an earlier step.
- Start
startdate and timeRequired - The new start. A time typed without a time zone, such as 2026-11-10 14:30, is the provider's.
- Provider
providertext - Move it to this provider. Leave blank to keep the same one.
- Only if the time is free
only_if_freetrue/false - Check the time is one of the provider's free times first, as the booking page does. Turn off to book it anyway, as staff can in the calendar.Default:
true.
Outputs
booked_attext- When it was booked, in Easy!Appointments' own time zone
calendar_urltext- The appointment in Easy!Appointments' calendar, for staff
customer_emailtext- The customer's email address
customer_first_nametext- The customer's first name
customer_idnumber- The customer's ID
customer_last_nametext- The customer's last name
customer_nametext- The customer's full name
customer_phonetext- The customer's phone number
datetext- The day it's on (2026-11-10)
duration_minutesnumber- How long it is, in minutes
endtext- When it ends, in the provider's time zone
ends_attext- When it ends, as ISO 8601 with the time zone's offset
idnumber- The appointment's ID, for the other Easy!Appointments steps
locationtext- Where it takes place
manage_urltext- The customer's page to reschedule or cancel it, as in their emails
meeting_linktext- Its video meeting link, if it has one
notestext- Its notes
previous_provider_nametext- Its provider before it was moved
previous_starttext- When it started before it was moved
provider_emailtext- The provider's email address
provider_idnumber- The provider's ID
provider_nametext- The provider's name
service_idnumber- The service's ID
service_nametext- The service, such as Consultation
starttext- When it starts, in the provider's time zone (2026-11-10 14:30)
starts_attext- When it starts, as ISO 8601 with the time zone's offset
statustext- Its status, such as Booked or Confirmed
timetext- The time it starts, on a 24-hour clock (14:30)
time_zonetext- The provider's time zone, such as America/New_York
Example output
{
"booked_at": "2026-11-05 19:36",
"calendar_url": "https://booking.example.com/index.php/calendar/reschedule/1sqcjHFVSi6Y",
"customer_email": "ada@example.com",
"customer_first_name": "Ada",
"customer_id": 6,
"customer_last_name": "Lovelace",
"customer_name": "Ada Lovelace",
"customer_phone": "+1 555 0101",
"date": "2026-11-11",
"duration_minutes": 30,
"end": "2026-11-11 09:30",
"ends_at": "2026-11-11T09:30:00-05:00",
"id": 42,
"location": "Riverside Clinic, 12 River St",
"manage_url": "https://booking.example.com/index.php/booking/reschedule/1sqcjHFVSi6Y",
"meeting_link": "",
"notes": "First visit",
"previous_provider_name": "Maya Patel",
"previous_start": "2026-11-10 14:30",
"provider_email": "maya.patel@example.com",
"provider_id": 4,
"provider_name": "Maya Patel",
"service_id": 2,
"service_name": "Consultation",
"start": "2026-11-11 09:00",
"starts_at": "2026-11-11T09:00:00-05:00",
"status": "Booked",
"time": "09:00",
"time_zone": "America/New_York"
}Update appointment
Change an appointment's status (such as Confirmed), notes, location or video meeting link. Only the fields filled in change.
Inputs
- Appointment ID
appointmenttextRequired - The appointment's ID, from a trigger or an earlier step.
- Status
statustext - The new status, such as Confirmed.
- Notes
notestext - New notes, in place of the old ones.
- Location
locationtext - Where it now takes place.
- Meeting link
meeting_linktext - A video meeting's web address, such as a Zoom or Teams link.
Outputs
booked_attext- When it was booked, in Easy!Appointments' own time zone
calendar_urltext- The appointment in Easy!Appointments' calendar, for staff
customer_emailtext- The customer's email address
customer_first_nametext- The customer's first name
customer_idnumber- The customer's ID
customer_last_nametext- The customer's last name
customer_nametext- The customer's full name
customer_phonetext- The customer's phone number
datetext- The day it's on (2026-11-10)
duration_minutesnumber- How long it is, in minutes
endtext- When it ends, in the provider's time zone
ends_attext- When it ends, as ISO 8601 with the time zone's offset
idnumber- The appointment's ID, for the other Easy!Appointments steps
locationtext- Where it takes place
manage_urltext- The customer's page to reschedule or cancel it, as in their emails
meeting_linktext- Its video meeting link, if it has one
notestext- Its notes
provider_emailtext- The provider's email address
provider_idnumber- The provider's ID
provider_nametext- The provider's name
service_idnumber- The service's ID
service_nametext- The service, such as Consultation
starttext- When it starts, in the provider's time zone (2026-11-10 14:30)
starts_attext- When it starts, as ISO 8601 with the time zone's offset
statustext- Its status, such as Booked or Confirmed
timetext- The time it starts, on a 24-hour clock (14:30)
time_zonetext- The provider's time zone, such as America/New_York
Example output
{
"booked_at": "2026-11-05 19:36",
"calendar_url": "https://booking.example.com/index.php/calendar/reschedule/1sqcjHFVSi6Y",
"customer_email": "ada@example.com",
"customer_first_name": "Ada",
"customer_id": 6,
"customer_last_name": "Lovelace",
"customer_name": "Ada Lovelace",
"customer_phone": "+1 555 0101",
"date": "2026-11-10",
"duration_minutes": 30,
"end": "2026-11-10 15:00",
"ends_at": "2026-11-10T15:00:00-05:00",
"id": 42,
"location": "Riverside Clinic, 12 River St",
"manage_url": "https://booking.example.com/index.php/booking/reschedule/1sqcjHFVSi6Y",
"meeting_link": "",
"notes": "First visit",
"provider_email": "maya.patel@example.com",
"provider_id": 4,
"provider_name": "Maya Patel",
"service_id": 2,
"service_name": "Consultation",
"start": "2026-11-10 14:30",
"starts_at": "2026-11-10T14:30:00-05:00",
"status": "Booked",
"time": "14:30",
"time_zone": "America/New_York"
}