Vagaro
App · 21 actions
Work with your Vagaro salon, spa or fitness business: locations, services and open times, appointments, customers, employees and their working hours, and time blocked off on their calendars.
Actions
| Action | What it does |
|---|---|
| Assign employee to locations | Give an employee, by their email, work at one or more locations (or a whole group) with an access level, and a calendar if you want one. |
| Create personal task | Block off time on an employee's calendar (a personal task), such as lunch or a day off, once or repeating. |
| Delete customer | Remove a customer from a business location. |
| Delete employee | Delete an employee from a business location. |
| Delete personal task | Delete a personal task. |
| Get appointment | Get an appointment's time, status, customer, employee and price, with a line for each service booked in it. |
| Get customer | Get a customer's name, email, phones, address, tags, birthday and points. |
| Get employee | Get an employee's name, contact details, role, access level and whether they can be booked online. |
| Get location | Get one business location's name, contact details, address and listing. |
| Get service | Get one service with its price, add-ons and the employees who perform it. |
| List a customer's appointments | List a customer's appointments at a location, by start time. |
| List access levels | List a location's access levels, such as Owner, Manager or Service Provider, with their IDs. |
| List locations | List the business's locations with their address, phone and listing. |
| List personal tasks | List the time an employee has blocked off (personal tasks) between two dates, or today if none are given. |
| List services | List a location's services and add-ons, with who performs each, for how long and at what price. |
| Search availability | Find open appointment times for a service on a date, or the first open times if no date is given, with each employee who has them. |
| Set working hours | Set when an employee works, and which services they offer then, on one date or on a weekday every week. |
| Unassign employee from locations | Deactivate an employee, by their email, at one or more locations or a whole group. |
| Update employee | Change an employee's name, phones, address, dates, manager or booking settings. |
| Update location | Change a location's name, contact details, address, website or where it is listed. |
| Update personal task | Change a one-off personal task's name, note, color, times or whether it blocks online booking. |
Assign employee to locations
Give an employee, by their email, work at one or more locations (or a whole group) with an access level, and a calendar if you want one.
Inputs
- Employee email
emailtextRequired - The email address the employee signs in to Vagaro with.
- Access level
access_level_idtextRequired - What they can do there, such as Manager. Choose the locations first, or give an ID from 'List access levels'.
- Locations
business_idslist - The locations. Choose these, or give a group name instead.
- Group name
group_nametext - A multi-location group's name, for every location in it, instead of choosing locations.
- Create a calendar
create_calendartrue/false - Give them a calendar so customers can book them.Default:
false.
Outputs
assignedtrue/false- True once assigned
business_idslist- The locations
calendar_createdtrue/false- Whether a calendar was asked for
emailtext- The employee's email
group_nametext- The group, if one was given
Example output
{
"assigned": true,
"business_ids": [
"U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE="
],
"calendar_created": true,
"email": "jenny@example.com",
"group_name": ""
}Create personal task
Block off time on an employee's calendar (a personal task), such as lunch or a day off, once or repeating. Customers can't book them online then unless you choose otherwise.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Employee ID
service_provider_idtextRequired - The employee's ID (Vagaro calls it the service provider ID), from 'Get service', 'Search availability' or an appointment.
- Start date
start_datedateRequired - The day it starts.
- Start time
start_timetimeRequired - When it starts, on the location's clock.
- End time
end_timetimeRequired - When it ends, on the location's clock.
- End date
end_datedate - The day it ends, for time off over several days. Defaults to the start date.
- Name
nametext - What it is, up to 100 characters, like Lunch.
- Comment
commenttext - A note, up to 500 characters.
- Color
colortext - Its color on the calendar, as a hex code like #e5b67f.
- Block online booking
block_online_bookingtext - Whether customers can't book this employee online during it. Vagaro blocks it unless you choose No.One of:
true(Yes),false(No). - Repeat
repeattext - How often it repeats. Leave blank for once.One of:
daily(Every day),weekly(Every week),monthly(Every month),yearly(Every year). - Repeat every
repeat_everynumber - How many days, weeks, months or years apart. Defaults to 1.From 1 to 99.
- On these days
repeat_days_of_weeklist - For a weekly repeat: the days of the week.One or more of:
monday,tuesday,wednesday,thursday,friday,saturday,sunday. - On day of the month
repeat_day_of_monthnumber - For a monthly or yearly repeat: the day of the month, 1 to 31.From 1 to 31.
- In month
repeat_monthtext - For a yearly repeat: the month.One of:
1(January),2(February),3(March),4(April),5(May),6(June),7(July),8(August),9(September),10(October),11(November),12(December). - Repeat until
repeat_untildate - The last day it repeats. Leave blank to repeat for good.
Outputs
personal_taskobject- What was sent to Vagaro
personal_task_idtext- The personal task's ID (a repeating one's series ID)
personal_task_idslist- The IDs of one-off personal tasks
recurring_rule_idslist- The series IDs of repeating ones
Example output
{
"personal_task": {
"blockOnlineBooking": true,
"businessId": "U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE=",
"endTime": "2026-11-10T13:00:00",
"personalTaskComment": "Back at 1",
"personalTaskHexCode": "#e5b67f",
"personalTaskName": "Lunch",
"recurrence": {
"daysOfMonth": 0,
"daysOfWeek": [
"tuesday"
],
"endDate": "2027-06-29",
"interval": 1,
"monthOfYear": 0,
"type": "weekly"
},
"serviceProviderId": "1TAhJhyWgIWWk-vlsSBAnw==",
"startTime": "2026-11-10T12:00:00"
},
"personal_task_id": "usqjshasdSjlKZjTE-Q==",
"personal_task_ids": [],
"recurring_rule_ids": [
"usqjshasdSjlKZjTE-Q=="
]
}Delete customer
Remove a customer from a business location. This can't be undone here.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Customer ID
customer_idtextRequired - The customer's ID, from an appointment or a Vagaro webhook.
Outputs
business_idtext- The location they were removed from
customer_idtext- The customer removed
deletedtrue/false- True once deleted
Example output
{
"business_id": "U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE=",
"customer_id": "FM1R4gT8OoDnqSAIK5jTtQ==",
"deleted": true
}Delete employee
Delete an employee from a business location. This can't be undone here.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Employee ID
service_provider_idtextRequired - The employee's ID (Vagaro calls it the service provider ID), from 'Get service', 'Search availability' or an appointment.
Outputs
business_idtext- The location
deletedtrue/false- True once deleted
service_provider_idtext- The employee deleted
Example output
{
"business_id": "U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE=",
"deleted": true,
"service_provider_id": "1TAhJhyWgIWWk-vlsSBAnw=="
}Delete personal task
Delete a personal task. For a repeating one, give a date to delete just that day, or that day and every one after it.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Personal task ID
personal_task_idtextRequired - The personal task's ID from 'Create personal task' or 'List personal tasks'. For a repeating one, its series ID.
- Date in the series
occurrence_datedate - For a repeating task: the day to delete. Leave blank otherwise.
- And every one after
rest_of_seriestrue/false - For a repeating task: also delete every day after that date.Default:
false.
Outputs
deletedtrue/false- True once deleted
occurrence_datetext- The day deleted, for a repeating task
personal_task_idtext- The personal task deleted
Example output
{
"deleted": true,
"occurrence_date": "",
"personal_task_id": "usqjshasdSjlKZjTE-Q=="
}Get appointment
Get an appointment's time, status, customer, employee and price, with a line for each service booked in it.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Appointment ID
appointment_idtextRequired - The appointment's ID, from a Vagaro webhook or an earlier step.
Outputs
appointmentobject- The first service booked
booked_serviceslist- Every service booked in it
countnumber- How many
Example output
{
"appointment": {
"amount": 25.0,
"appointmentId": "juAUYXCq~EjSHCX5CwucPg==",
"appointmentTypeCode": "RR",
"appointmentTypeName": "Return Request",
"bookingSource": "Vagaro Marketplace",
"bookingStatus": "Confirmed",
"calendarEventId": "",
"createdBy": "FM1R4gT8OoDnqSAIK5jTtQ==",
"createdDate": "2024-10-10T14:44:37.350Z",
"customerId": "FM1R4gT8OoDnqSAIK5jTtQ==",
"endTime": "2024-10-10T21:45:00.000Z",
"eventType": "Appointment",
"formResponseIds": [],
"modifiedBy": "FM1R4gT8OoDnqSAIK5jTtQ==",
"modifiedDate": "2024-10-10T15:00:00.000Z",
"onlineVsInhouse": "Booked Online",
"serviceCategory": "Hair Services",
"serviceId": "~yJZcatIl80KSY0sNCfpTQ==",
"serviceProviderId": "1TAhJhyWgIWWk-vlsSBAnw==",
"serviceTitle": "Mens Haircut",
"startTime": "2024-10-10T21:15:00.000Z"
},
"booked_services": [
{
"amount": 25.0,
"appointmentId": "juAUYXCq~EjSHCX5CwucPg==",
"appointmentTypeCode": "RR",
"appointmentTypeName": "Return Request",
"bookingSource": "Vagaro Marketplace",
"bookingStatus": "Confirmed",
"calendarEventId": "",
"createdBy": "FM1R4gT8OoDnqSAIK5jTtQ==",
"createdDate": "2024-10-10T14:44:37.350Z",
"customerId": "FM1R4gT8OoDnqSAIK5jTtQ==",
"endTime": "2024-10-10T21:45:00.000Z",
"eventType": "Appointment",
"formResponseIds": [],
"modifiedBy": "FM1R4gT8OoDnqSAIK5jTtQ==",
"modifiedDate": "2024-10-10T15:00:00.000Z",
"onlineVsInhouse": "Booked Online",
"serviceCategory": "Hair Services",
"serviceId": "~yJZcatIl80KSY0sNCfpTQ==",
"serviceProviderId": "1TAhJhyWgIWWk-vlsSBAnw==",
"serviceTitle": "Mens Haircut",
"startTime": "2024-10-10T21:15:00.000Z"
}
],
"count": 1
}Get customer
Get a customer's name, email, phones, address, tags, birthday and points.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Customer ID
customer_idtextRequired - The customer's ID, from an appointment or a Vagaro webhook.
Outputs
customerobject- The customer
Example output
{
"customer": {
"birthday": "1990-05-15",
"city": "Pleasanton",
"countryCode": "US",
"countryName": "United States of America",
"createdBy": "-qZquhR8c4T6NRg5ixIjoQ==",
"createdDate": "2024-08-22T20:01:21.736Z",
"customerFirstName": "Johnny",
"customerId": "FM1R4gT8OoDnqSAIK5jTtQ==",
"customerLastName": "Smith",
"dayPhone": "7015556667",
"email": "johnny@example.com",
"gender": "male",
"generalTags": [
"VIP"
],
"mobilePhone": "1112223334",
"nightPhone": "",
"pointsBalance": 0,
"postalCode": "94568",
"regionCode": "US-CA",
"regionName": "California",
"streetAddress": "4430 Rosewood Drive"
}
}Get employee
Get an employee's name, contact details, role, access level and whether they can be booked online.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Employee ID
service_provider_idtextRequired - The employee's ID (Vagaro calls it the service provider ID), from 'Get service', 'Search availability' or an appointment.
Outputs
employeeobject- The employee
Example output
{
"employee": {
"accessLevelId": "sdaj923isjkkKqUd3==",
"birthday": "1990-05-15",
"businessGroupId": "inxjtGYKSgfipAAvU6BQ6A==",
"city": "Pleasanton",
"countryCode": "US",
"countryName": "United States of America",
"createdBy": "-qZquhR8c4T6NRg5ixIjoQ==",
"createdDate": "2024-08-22T20:01:21.736Z",
"email": "jenny@example.com",
"employeeCardId": 1234,
"employeeFirstName": "Jenny",
"employeeLastName": "Hare",
"employeeType": "Service Provider",
"isActive": true,
"isOnlineBookingActive": true,
"phone": "1112223334",
"postalCode": "94568",
"regionCode": "US-CA",
"regionName": "California",
"reportsTo": "sjdjgn371RPEGJwhd==",
"serviceProviderId": "1TAhJhyWgIWWk-vlsSBAnw==",
"startDate": "2024-10-01T00:00:00",
"streetAddress": "4430 Rosewood Drive"
}
}Get location
Get one business location's name, contact details, address and listing.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
Outputs
locationobject- The location
Example output
{
"location": {
"businessAlias": "VSalon",
"businessEmail": "vagarosalon@example.com",
"businessGroupId": "tYKEZF-L445YEDnCx0TIfA==",
"businessId": "U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE=",
"businessName": "Vagaro Salon & Spa",
"businessPhone": "1234567890",
"businessWebsite": "https://www.vsalonspa.com",
"city": "New York",
"countryCode": "US",
"countryName": "United States of America",
"createdDate": "2024-02-15T05:25:00Z",
"listedOnVagaro": true,
"postalCode": "10030",
"regionCode": "NY",
"regionName": "New York",
"streetAddress": "498 Edgecombe Avenue Manhattan",
"vagaroListingUrl": "https://www.vagaro.com/vsalonspa"
}
}Get service
Get one service with its price, add-ons and the employees who perform it.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Service
service_idtextRequired - The service. Pick one, or give its ID from an earlier step.
Outputs
serviceobject- The service
Example output
{
"service": {
"addOnIds": [
"asdfnauuudma8837=="
],
"businessCost": 9.99,
"cleanUpTimeMinutes": 0,
"currency": "USD",
"isLiveStreamService": false,
"isMobileService": false,
"parentServiceId": "savf7ss7jeRPEn7gGQ==",
"parentServiceTitle": "Haircuts and Other",
"serviceId": "~yJZcatIl80KSY0sNCfpTQ==",
"servicePerformedBy": [
{
"currency": "USD",
"durationMinutes": 30,
"pointsGiven": 0,
"pointsRedeem": 0,
"price": 19.99,
"priceWithTax": 21.99,
"serviceProviderId": "1TAhJhyWgIWWk-vlsSBAnw=="
}
],
"serviceTitle": "Mens Haircut",
"showOnlineStatus": "ServiceAndPrice",
"showPriceAsStartingPoint": false,
"type": "Service"
}
}List a customer's appointments
List a customer's appointments at a location, by start time. Gets one page; run it again with the next page to see more.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Customer ID
customer_idtextRequired - The customer's ID, from an appointment or a Vagaro webhook.
- Order
ordertext - Earliest or latest start time first.One of:
asc(Earliest first),desc(Latest first). - Page
page_numbernumber - Which page to get, from 1. Use 'next_page' from the last run.At least 1.
- Page size
page_sizenumber - How many to get, 1 to 100. Defaults to 25.From 1 to 100.
Outputs
appointmentslist- The appointments
countnumber- How many are on this page
next_pagenumber- The page to ask for next, or 0 when this is the last
page_numbernumber- The page these are
Example output
{
"appointments": [
{
"amount": 25.0,
"appointmentId": "juAUYXCq~EjSHCX5CwucPg==",
"appointmentTypeCode": "RR",
"appointmentTypeName": "Return Request",
"bookingSource": "Vagaro Marketplace",
"bookingStatus": "Confirmed",
"calendarEventId": "",
"createdBy": "FM1R4gT8OoDnqSAIK5jTtQ==",
"createdDate": "2024-10-10T14:44:37.350Z",
"customerId": "FM1R4gT8OoDnqSAIK5jTtQ==",
"endTime": "2024-10-10T21:45:00.000Z",
"eventType": "Appointment",
"formResponseIds": [],
"modifiedBy": "FM1R4gT8OoDnqSAIK5jTtQ==",
"modifiedDate": "2024-10-10T15:00:00.000Z",
"onlineVsInhouse": "Booked Online",
"serviceCategory": "Hair Services",
"serviceId": "~yJZcatIl80KSY0sNCfpTQ==",
"serviceProviderId": "1TAhJhyWgIWWk-vlsSBAnw==",
"serviceTitle": "Mens Haircut",
"startTime": "2024-10-10T21:15:00.000Z"
}
],
"count": 1,
"next_page": 0,
"page_number": 1
}List access levels
List a location's access levels, such as Owner, Manager or Service Provider, with their IDs.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
Outputs
access_levelslist- The access levels
countnumber- How many
Example output
{
"access_levels": [
{
"accessLevelId": "U2FsdGVkX1~2DvvA1wIthsAH7IJxAZmeGBK~TnaMJQA=",
"accessLevelName": "Manager / Supervisor",
"isActive": true
}
],
"count": 1
}List locations
List the business's locations with their address, phone and listing. Gets one page; run it again with the next page to see more.
Inputs
- Page
page_numbernumber - Which page to get, from 1. Use 'next_page' from the last run.At least 1.
- Page size
page_sizenumber - How many to get, 1 to 100. Defaults to 25.From 1 to 100.
Outputs
countnumber- How many are on this page
locationslist- The locations
next_pagenumber- The page to ask for next, or 0 when this is the last
page_numbernumber- The page these are
Example output
{
"count": 1,
"locations": [
{
"businessAlias": "VSalon",
"businessEmail": "vagarosalon@example.com",
"businessGroupId": "tYKEZF-L445YEDnCx0TIfA==",
"businessId": "U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE=",
"businessName": "Vagaro Salon & Spa",
"businessPhone": "1234567890",
"businessWebsite": "https://www.vsalonspa.com",
"city": "New York",
"countryCode": "US",
"countryName": "United States of America",
"createdDate": "2024-02-15T05:25:00Z",
"listedOnVagaro": true,
"postalCode": "10030",
"regionCode": "NY",
"regionName": "New York",
"streetAddress": "498 Edgecombe Avenue Manhattan",
"vagaroListingUrl": "https://www.vagaro.com/vsalonspa"
}
],
"next_page": 0,
"page_number": 1
}List personal tasks
List the time an employee has blocked off (personal tasks) between two dates, or today if none are given. Gets one page; run it again with the next page to see more.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Employee ID
service_provider_idtextRequired - The employee's ID (Vagaro calls it the service provider ID), from 'Get service', 'Search availability' or an appointment.
- From
start_datedate - The first day to look at. Defaults to today.
- Until
end_datedate - The last day to look at. Defaults to the first day.
- Page
page_numbernumber - Which page to get, from 1. Use 'next_page' from the last run.At least 1.
- Page size
page_sizenumber - How many to get, 1 to 100. Defaults to 25.From 1 to 100.
Outputs
countnumber- How many are on this page
next_pagenumber- The page to ask for next, or 0 when this is the last
page_numbernumber- The page these are
personal_taskslist- The personal tasks
Example output
{
"count": 1,
"next_page": 0,
"page_number": 1,
"personal_tasks": [
{
"blockOnlineBooking": true,
"businessId": "U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE=",
"endTime": "2026-11-10T13:00:00",
"personalTaskComment": "Back at 1",
"personalTaskHexCode": "#e5b67f",
"personalTaskId": "usqjshasdSjlKZjTE-Q==",
"personalTaskName": "Lunch",
"recurrence": {
"daysOfMonth": 0,
"daysOfWeek": [
"tuesday"
],
"endDate": "2027-06-29",
"interval": 1,
"monthOfYear": 0,
"type": "weekly"
},
"serviceProviderId": "1TAhJhyWgIWWk-vlsSBAnw==",
"startTime": "2026-11-10T12:00:00"
}
]
}List services
List a location's services and add-ons, with who performs each, for how long and at what price. Gets one page; run it again with the next page to see more.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Page
page_numbernumber - Which page to get, from 1. Use 'next_page' from the last run.At least 1.
- Page size
page_sizenumber - How many to get, 1 to 100. Defaults to 25.From 1 to 100.
Outputs
countnumber- How many are on this page
next_pagenumber- The page to ask for next, or 0 when this is the last
page_numbernumber- The page these are
serviceslist- The services
Example output
{
"count": 1,
"next_page": 0,
"page_number": 1,
"services": [
{
"addOnIds": [
"asdfnauuudma8837=="
],
"businessCost": 9.99,
"cleanUpTimeMinutes": 0,
"currency": "USD",
"isLiveStreamService": false,
"isMobileService": false,
"parentServiceId": "savf7ss7jeRPEn7gGQ==",
"parentServiceTitle": "Haircuts and Other",
"serviceId": "~yJZcatIl80KSY0sNCfpTQ==",
"servicePerformedBy": [
{
"currency": "USD",
"durationMinutes": 30,
"pointsGiven": 0,
"pointsRedeem": 0,
"price": 19.99,
"priceWithTax": 21.99,
"serviceProviderId": "1TAhJhyWgIWWk-vlsSBAnw=="
}
],
"serviceTitle": "Mens Haircut",
"showOnlineStatus": "ServiceAndPrice",
"showPriceAsStartingPoint": false,
"type": "Service"
}
]
}Search availability
Find open appointment times for a service on a date, or the first open times if no date is given, with each employee who has them.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Service
service_idtextRequired - The service. Pick one, or give its ID from an earlier step.
- Date
appointment_datedate - The day to search. Leave blank for the first open times.
- Employee IDs
service_provider_idslist - Only these employees. Leave empty for everyone.
- Add-ons
add_on_idslist - Add-ons booked with the service, which can make it longer.
Outputs
availabilitylist- Each option: the employees, the date and its open times
countnumber- How many
time_slot_countnumber- Open times in all
Example output
{
"availability": [
{
"appointmentDate": "2026-11-10",
"items": [
{
"duration": 30,
"serviceId": "~yJZcatIl80KSY0sNCfpTQ==",
"serviceProvider": "Jenny Hare",
"serviceProviderId": "1TAhJhyWgIWWk-vlsSBAnw==",
"serviceTitle": "Mens Haircut"
}
],
"timeSlot": [
"09:00",
"09:30"
]
}
],
"count": 1,
"time_slot_count": 2
}Set working hours
Set when an employee works, and which services they offer then, on one date or on a weekday every week. Replaces their hours for that day with one block of time, or a day off.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Employee ID
service_provider_idtextRequired - The employee's ID (Vagaro calls it the service provider ID), from 'Get service', 'Search availability' or an appointment.
- For
hours_typetextRequired - One date only, or the same weekday every week.One of:
calendarWorkingHours(One date),regularWorkingHours(Every week, on one day). - Date
datedate - For one date: which date.
- Day of the week
day_of_weektext - For every week: which day.One of:
monday,tuesday,wednesday,thursday,friday,saturday,sunday. - Start time
start_timetime - When they start work, on the location's clock.
- End time
end_timetime - When they finish work, on the location's clock.
- Day off
day_offtrue/false - Make it a day off instead of giving times.Default:
false. - Services offered
service_idslist - The services they offer in these hours. Leave empty for all.
- Every same weekday
repeat_for_same_daytrue/false - For one date: use these hours on that weekday every week too.Default:
false.
Outputs
datetext- The date, for one date
day_of_weektext- The weekday, for every week
hours_typetext- calendarWorkingHours (one date) or regularWorkingHours (weekly)
service_provider_idtext- The employee
slotslist- The hours sent
updatedtrue/false- True once set
Example output
{
"date": "",
"day_of_week": "monday",
"hours_type": "regularWorkingHours",
"service_provider_id": "1TAhJhyWgIWWk-vlsSBAnw==",
"slots": [
{
"dayOfWeek": "monday",
"endTime": "17:00",
"serviceIds": [],
"startTime": "09:00"
}
],
"updated": true
}Unassign employee from locations
Deactivate an employee, by their email, at one or more locations or a whole group. Their calendar is kept unless you say otherwise.
Inputs
- Employee email
emailtextRequired - The email address the employee signs in to Vagaro with.
- Locations
business_idslist - The locations. Choose these, or give a group name instead.
- Group name
group_nametext - A multi-location group's name, for every location in it, instead of choosing locations.
- Keep their calendar
keep_calendartext - Keep the employee's calendar. Choose No to remove it.One of:
true(Yes),false(No).
Outputs
business_idslist- The locations
calendar_kepttrue/false- Whether their calendar was kept
emailtext- The employee's email
group_nametext- The group, if one was given
unassignedtrue/false- True once unassigned
Example output
{
"business_ids": [
"U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE="
],
"calendar_kept": true,
"email": "jenny@example.com",
"group_name": "",
"unassigned": true
}Update employee
Change an employee's name, phones, address, dates, manager or booking settings. Only the fields filled in change. Returns the employee as they are now.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Employee ID
service_provider_idtextRequired - The employee's ID (Vagaro calls it the service provider ID), from 'Get service', 'Search availability' or an appointment.
- First name
first_nametext - A new first name.
- Last name
last_nametext - A new last name.
- Day phone
day_phonetext - The daytime phone, including the country code.
- Evening phone
night_phonetext - The evening phone, including the country code.
- Street number
street_numbertext - The street number, like 123.
- Street
streettext - The street name, like Main Street.
- City
citytext - The city.
- State
statetext - The state, like California.
- Postal code
postal_codetext - The zip or postal code.
- Country code
country_codetext - The two-letter country code, like US.
- Birthday
birthdaydate - The employee's birthday.
- Start date
start_datedate - The day the employee started.
- Reports to
reports_totext - The employee ID of the person they report to.
- Card ID
employee_card_idnumber - The employee's card number.At least 0.
- Online booking
online_bookingtext - Let customers book them online. Leave blank to keep it as it is.One of:
true(Yes),false(No). - Shown on staff page
shown_on_staff_pagetext - Show them on the staff tab of your booking page. Leave blank to keep it as it is.One of:
true(Yes),false(No). - Show contact details
show_contact_informationtext - Let customers see their email and phone on Vagaro. Leave blank to keep it as it is.One of:
true(Yes),false(No).
Outputs
employeeobject- The employee as they are now
service_provider_idtext- The employee changed
updated_fieldslist- The Vagaro fields that were sent
Example output
{
"employee": {
"accessLevelId": "sdaj923isjkkKqUd3==",
"birthday": "1990-05-15",
"businessGroupId": "inxjtGYKSgfipAAvU6BQ6A==",
"city": "Pleasanton",
"countryCode": "US",
"countryName": "United States of America",
"createdBy": "-qZquhR8c4T6NRg5ixIjoQ==",
"createdDate": "2024-08-22T20:01:21.736Z",
"email": "jenny@example.com",
"employeeCardId": 1234,
"employeeFirstName": "Jenny",
"employeeLastName": "Hare",
"employeeType": "Service Provider",
"isActive": true,
"isOnlineBookingActive": true,
"phone": "1112223334",
"postalCode": "94568",
"regionCode": "US-CA",
"regionName": "California",
"reportsTo": "sjdjgn371RPEGJwhd==",
"serviceProviderId": "1TAhJhyWgIWWk-vlsSBAnw==",
"startDate": "2024-10-01T00:00:00",
"streetAddress": "4430 Rosewood Drive"
},
"service_provider_id": "1TAhJhyWgIWWk-vlsSBAnw==",
"updated_fields": [
"employeeFirstName"
]
}Update location
Change a location's name, contact details, address, website or where it is listed. Only the fields filled in change. Returns the location as it is now.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Name
business_nametext - A new name for the location.
- Nickname
business_aliastext - A new nickname. Only multi-location businesses have one.
- Phone
business_phonetext - The location's phone number, 10 digits including the country code.
- Email
business_emailtext - The location's email address.
- Street number
street_numbertext - The street number, like 123.
- Street
streettext - The street name, like Main Street.
- City
citytext - The city.
- State
statetext - The state, like California.
- Postal code
postal_codetext - The zip or postal code.
- Country code
country_codetext - The two-letter country code, like US.
- Where services happen
service_locationtext - At the business, at the client's location, or both.One of:
AtBusiness(At the business),AtClientsLocation(At the client's location),Both. - Website
business_websitetext - The business website's full address, like https://salonabc.com.
- Vagaro listing address
vagaro_listing_pathtext - The end of your Vagaro listing address: salonabc for https://www.vagaro.com/salonabc.
- Listed on Vagaro
listed_on_vagarotext - Show the location on Vagaro. Leave blank to keep it as it is.One of:
true(Yes),false(No). - Listed on Google
listed_on_googletext - List the location on Google. Leave blank to keep it as it is.One of:
true(Yes),false(No). - Listed on Apple Maps
listed_on_apple_mapstext - List the location on Apple Maps. Leave blank to keep it as it is.One of:
true(Yes),false(No). - Show phone number
show_contact_informationtext - Show the phone number on the Vagaro listing. Leave blank to keep it as it is.One of:
true(Yes),false(No). - Show message button
show_vagaro_connecttext - Show the message button on the Vagaro listing. Leave blank to keep it as it is.One of:
true(Yes),false(No).
Outputs
business_idtext- The location changed
locationobject- The location as it is now
updated_fieldslist- The Vagaro fields that were sent
Example output
{
"business_id": "U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE=",
"location": {
"businessAlias": "VSalon",
"businessEmail": "vagarosalon@example.com",
"businessGroupId": "tYKEZF-L445YEDnCx0TIfA==",
"businessId": "U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE=",
"businessName": "Vagaro Salon & Spa",
"businessPhone": "1234567890",
"businessWebsite": "https://www.vsalonspa.com",
"city": "New York",
"countryCode": "US",
"countryName": "United States of America",
"createdDate": "2024-02-15T05:25:00Z",
"listedOnVagaro": true,
"postalCode": "10030",
"regionCode": "NY",
"regionName": "New York",
"streetAddress": "498 Edgecombe Avenue Manhattan",
"vagaroListingUrl": "https://www.vagaro.com/vsalonspa"
},
"updated_fields": [
"businessName"
]
}Update personal task
Change a one-off personal task's name, note, color, times or whether it blocks online booking. What you leave blank stays as it is.
Inputs
- Location
business_idtextRequired - The business location. Pick one, or give its ID from an earlier step.
- Employee ID
service_provider_idtextRequired - The employee's ID (Vagaro calls it the service provider ID), from 'Get service', 'Search availability' or an appointment.
- Personal task ID
personal_task_idtextRequired - The personal task's ID from 'Create personal task' or 'List personal tasks'. For a repeating one, its series ID.
- Name
nametext - What it is, up to 100 characters, like Lunch. Leave blank to keep it.
- Comment
commenttext - A note, up to 500 characters. Leave blank to keep it.
- Color
colortext - Its color on the calendar, as a hex code like #e5b67f. Leave blank to keep it.
- Block online booking
block_online_bookingtext - Whether customers can't book this employee online during it. Leave blank to keep it.One of:
true(Yes),false(No). - Start date
start_datedate - A new start day. Leave blank to keep it.
- Start time
start_timetime - A new start time, on the location's clock. Leave blank to keep it.
- End date
end_datedate - A new end day. Leave blank to keep it.
- End time
end_timetime - A new end time, on the location's clock. Leave blank to keep it.
Outputs
personal_taskobject- What was sent to Vagaro
personal_task_idtext- The personal task's ID (a repeating one's series ID)
personal_task_idslist- The IDs of one-off personal tasks
recurring_rule_idslist- The series IDs of repeating ones
Example output
{
"personal_task": {
"blockOnlineBooking": true,
"businessId": "U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE=",
"endTime": "2026-11-10T13:00:00",
"personalTaskComment": "Back at 1",
"personalTaskHexCode": "#e5b67f",
"personalTaskName": "Lunch",
"recurrence": {
"daysOfMonth": 0,
"daysOfWeek": [
"tuesday"
],
"endDate": "2027-06-29",
"interval": 1,
"monthOfYear": 0,
"type": "weekly"
},
"serviceProviderId": "1TAhJhyWgIWWk-vlsSBAnw==",
"startTime": "2026-11-10T12:00:00"
},
"personal_task_id": "usqjshasdSjlKZjTE-Q==",
"personal_task_ids": [],
"recurring_rule_ids": [
"usqjshasdSjlKZjTE-Q=="
]
}