TimeTap

Triggers when there is a new appointment added to the appointment list report.

Triggers when an appointment report is generated.

Triggers when a new client is created or updated.

Triggers when a new email is received.

Triggers when a new file is added or an existing file is modified.

Triggers when new job data is available.

Triggers when a new entry is added to the waitlist.

Checks for duplicate client emails to ensure uniqueness.

Creates a new appointment.

Creates a new blocking appointment object on an account.

Creates a new client object on an account.

Returns all client objects matching the search parameters used in an array format. Returns an object with clientId = -1 in the array for adding a new client.

Returns all client objects that have the tag passed in the request body assigned to them in array format.

Creates a new email message to be sent.

Returns an email set object with the status set to "QUEUED" and the body property merged with the correct values from the specified calendar ID.

Creates a new email delivery record.

Sends an email out for a specified invoice.

Sends an email to multiple appointments.

Updates an existing file object or creates a folder.

Uploads a file to the file library. Files can be made public or private.

Sends an email invitation to specified clients.

Sends an email invitation to a staff member to create an appointment.

Creates a new job object on a business account.

Creates a new job requisition object on a business account. The request body must include a job requisition object.

Creates a new note object on a business account.

Runs the specified report.

Creates a new staff object on an account.

Creates a new time-off object on an account.

Creates a waitlist for organizing individuals or entities in a queue.

Creates a new period object for a location or staff person.

Returns a workingHours period object so a user can edit times on the days that were selected. This call is made between steps 2 and 3 in the Add Staff Availability flow under Settings > Time.

Creates a new timeslot of availability for a staff member at a specified location during an existing period.

Creates a new time slot of availability at a location for the staff person indicated by the call in an existing period.

Removes a client object from view by setting its active property to false.

Removes a file entirely by going into the file repository and deleting it.

Removes a specified job object from view by setting its active property to false.

Removes the specified job requisition object from view by setting its active property to false.

Removes a note object from view by setting its deleted property to true.

Removes a staff object by setting its active property to false. Requires a JSON POST body with values to cancel open appointments and send affected clients an email explanation, including a personalized message.

Removes a TimeOff object from view by setting its active property to false.

Deletes a waitlist entry using the specified ID.

Removes any specified time slots in the given period, ensuring those times are no longer available for booking.

Removes a working hours timeslot from the schedule.

Returns all client objects that have the specified email address in array format. If none qualify, returns an empty array.

Returns a JSON object for the specified appointment.

Checks the waitlist of the specified appointment before updating the appointment object.

Returns an array of appointment objects that are part of a recurring appointment series containing the specified appointment, as determined by the recurringAppointmentId.

Returns all appointment objects on an account in array format. To get time offs to return, set the excludeTimeOff parameter to false and set the onlyTimeOff parameter to 1.

Retrieves the status list of an appointment resource.

Returns an array containing one event object. Possible values for event type include "APPOINTMENT," "CLASS," "TIME_OFF," and "VACATION."

Returns a JSON object for a specified client.

Returns the number of active clients on an account, used in the app to create pagination on the client's list.

Returns an object that contains a list of the client IDs for the clients that match the parameters passed with the call.

Returns a count object that provides the number of clients that match the parameters passed with the call.

Returns strings of tags in array format that are assigned to the specified client.

Returns an array of client objects that the specified client can access when they log in to the public scheduler.

Returns an array of client objects that can access a specified clientAccountId when they log in to the public scheduler.

Returns a JSON object for the specified email that was sent.

Returns all email sent objects for a specified appointment in array format.

Returns all email sent objects to a specified client in array format.

Returns all email sent objects for the specified appointment and any email objects sent for the recurring appointment series it belongs to in an array format.

Returns an email disclaimer.

Returns all emails sent out for a specified invitation.

Returns all email sent objects for a specified invoice in an array format.

Returns all email sent objects for a specified recurring appointment in array format.

Returns all emails sent that use a specified email template in array format.

Returns an email object for a person to edit before it gets sent out for the specified waitlist ID.

Returns a JSON object for the specified invitation.

Returns a JSON object for the specified invitation campaign.

Returns a JSON object for a specified job requisition by job ID.

Returns an active Job Requisition object in the account that matches the requisition number passed in the URL to ensure no duplicate Job Requisition numbers are added to the account.

Returns all job requisition objects on an account in array format.

Returns all job objects on an account in array format.

Returns all tags for a job in array format.

Returns all notes objects for the specified appointment using the calendar ID.

Returns all notes objects for the specified client.

Returns an array of strings representing each report category code on an account.

Returns a list of report objects in the specified category.

Returns a JSON object for the specified staff person by their professional ID.

Returns an object that contains a list of the professional IDs for the locations that match the parameters passed with the call.

Returns an object that contains a list of staff members that match the parameters passed with the call.

Returns a count object that provides the number of staff members that match the parameters passed with the call.

Returns the objects of all services and classes on the account in array format.

Returns a JSON object for the specified time off.

Retrieves a waitlist by its ID.

Returns a working hours object with the business ID and period array for the location on behalf of which the call was made.

Returns a workingHours object with the business ID and period array for the staff on whose behalf the call was made.

Makes an arbitrary call to a specified service or endpoint.

Merges a client's account with another account of a specified client.

Updates client data.

Returns the number of appointments based on the parameters that are passed.

Returns all appointment objects on an account in array format.

Returns the number of appointments based on the parameters passed for each appointment status included in the statusList parameter.

Retrieves appointment reports along with their count from the service.

Returns events as determined by the parameters that get passed in the URL in array format. The staffIdList is passed in the URL as a comma-separated list of staff IDs.

Returns an array of client objects for any clients matching the specified external user name. If using an email address as the external username, a "/" must be included at the end of the URL for the call to return.

Returns an object that contains a list of clients that match the parameters passed with the call.

Returns an object that contains a list of clients along with a count of the total number of clients that match the parameters passed with the call.

Returns all client objects on an account in array format.

Returns all email sent objects that have status = BOUNCED.

Returns all email sent objects by a business's account in an array format.

Returns all file objects on a business's account in array format.

Returns all invitation campaign objects on a business's account in array format.

Returns all invitation objects for a specified invitation campaign.

Returns all staff objects on an account in array format.

Searches for staff members in the StaffList and returns the count of entries found.

Retrieves all objects from the waitlist.

Updates an existing appointment object.

Sets an appointment to a substatus of CANCELLED and alters the boolean property accordingly to notify the client via email, effectively cancelling the appointment with the option to send an email to the staff and the client.

Sets an appointment to a substatus of COMPLETED and alters a boolean flag accordingly to send a thank you email to the client.

Sets an appointment to a substatus of NO_SHOW and alters a boolean flag to notify the client via email.

Updates an appointment's status and substatus.

Updates an existing client object.

Updates an existing invitation campaign object, specifically the description and expiration date.

Updates an existing job object in a business account. The object must include the job ID property filled with the job requisition ID value of the job object to be updated.

Updates an existing job requisition object on a business's account.

Updates an existing note object on a business account.

Updates an existing staff object on an account.

Updates an existing staff service.

Updates an existing time off object.

Updates existing time slots or date ranges using the originalStartDate and originalEndDate parameters.