The name of the company

The unique nickname of the account. Also create's the account's profile page https://nickname.setster.com. May contain only letters and digits

The unique ID of the account

Contact of the main and default employee. Together with the password is used as user name

Used along with the account email

The company's website URL.

The company's main email address.

The Facebook company page URL.

The Linkedin company page URL.

The Twitter account URL of the company.

The Skype nickname of the company Skype account.

The company's Yelp page URL

The company's Pinterest page URL

The company's Vimeo page URL

The company's YouTube channel URL

The main business phone number

The account's set timezone ID

The main business fax number

The company's about us section. Optional content visitble to users during booking an appointment

Personal info for the main/default employee

Personal info for the main/default employee

The ID of the company owner/main employee

The city in the account address

The country of the account address.

The state of the account address

The street address of the account address

The street address line 2 of the account address

The zip code of the account address.

Shows or hides the company map view on the profile page

The Google map URL for the account address.

The URL a user will be directed to after booking an appointment

The company's booking policy. Optional content visitble to users during booking an appointment

The subscription plan of the account.

The date the account was created

The number of times the account's booking widget was loaded/viewd.

Notify the staff/employees of new unconfirmed appointments

Notify the staff/employees of new unpaid appointments

The language of the account

An account has multiple location creation previlidges

The number of licenses the account is susubscribed/paying for.

The label for the company's main business hours.

The label for the company's booking policy.

The label for the company's account section.

The GMT offset in minutes of the account's timezone

The name of the company

The unique nickname of the account. Also create's the account's profile page https://nickname.setster.com. May contain only letters and digits

The company's website URL.

The company's main email address.

The Facebook company page URL.

The Linkedin company page URL.

The Twitter account URL of the company.

The Skype nickname of the company Skype account.

The company's Yelp page URL

The company's Pinterest page URL

The company's Vimeo page URL

The company's YouTube channel URL

The main business phone number

The account's set timezone ID

The main business fax number

Contact of the main and default employee. Together with the password is used as user name

Used along with the account email

Personal info for the main/default employee

Personal info for the main/default employee

The ID of the company that the appointment belongs to. Field is writable when entity is owned by child account

The email of the client that made the appointment

The client name

The ID of the service that the appointment is made for

The date and time when the appointment is scheduled to start. The time is local to the company timezone or the location timezone (if the location is in a different timezone). The format of the date is yyyy-mm-dd hh:mm:ss

Unique ID of the appointment

The ID of the client that made the appointment

The client phone number

The client address

The ID of the employee (provider) that the appointment is made for

The email of the provider/employee that the appointment was made for

The ID of the location where the appointment will take place at

The date and time when the appointment is scheduled to end. The time is local to the company timezone or the location timezone (if the location is in a different timezone). The format of the date is yyyy-mm-dd hh:mm:ss

The duration of the appointment (in milliseconds). Example: 30 minutes = 1800000 milliseconds.

The appointment time padding (in seconds) - the number of seconds, before and after an appointment, that cannon be used for another appointment

Custom client message

Appointment status. Possible values:

• 0 - waiting email confirmation from the client
• 1 - email confirmed but not validated by the admin/provider
• 2 - email confirmed and validated or paid
• 3 - declined or canceled
• 4 - busy time imported from external sources (e.g. google)
• 6 - busy time imported from Zapier
• 8 - completed
• 9 - no show (the scheduled event did not take place)
• 10 - in progress
• 11 - checked in
• 12 - just arrived
• 13 - delayed

The name of the service with ID service_id

The date and time when the latest change was made to the appointment

IDs of sub services that were selected for the appointment separated by comma

Whether the appointment has been paid or not, if the service requires a payment.

The values of the booking form fields filled by the client.

Custom fields are tied to your Setster Booking Form. New custom data can be added by creating a new field in the Setster dashboard under Booking Form.

Replaces the deprecated custom_fields property.

Custom data is tied to your Setster Booking Form. New custom data can be added by creating a new field in the Setster dashboard under Booking Form.

Expects an object containing key values pairs where the key matches one of your booking form field keys and the value is any custom data value.

The time zone short name (e.g. PST or GMT+4)

The time zone offset in seconds

The length (in minutes) of the appointment

Relevant only if return=boxes and represents the number of minutes in one box

Relevant only if return=boxes and represents the number of minutes between two adjacent appointments

Selected day

Selected month

Selected year

The ID of the company that the client belongs to

The ID of the employee that the client is associated with

The email of the client

The full name of the client

Unique ID of the client

Client's phone number

The date and time of the last appointment made by the client

The date and time when the record was created.

Client's address

The gender of the client

Only the day and month are relevant

The date the client first scheduled an appointment or was created. This field is editable.

Whether or not the client accepts email marketing

The ID of the company that the custom field belongs to

The label of the custom field

The max string length of the custom field

Type of the custom field. Possible values:

• 0 - text
• 1 - multiline
• 2 - phone
• 3 - email
• 4 - hidden
• 5 - address
• 6 - title

If the custom field is mandatory in the booking form

The order in layout

The enabled/disabled status.

Places where the custom field is visible. Possible values:

• 1 - Appointment submit form
• 2 - Contact form
• 3 - Both forms

The readonly property of the custom field form.

The hint property of the custom field form

Unique ID of the custom field

The ID of the company of the employee. Field is writable when entity is owned by child account.

Unique Email address of the employee

First Name

Last Name

Unique ID of the employee

Job name

Bio

Phone number

Photo URL

Whether or not the employee's email will be displayed on the widget

Employee status: active / inactive

Automatically generated based on the first and last names

Unique nickname per company. May contain only letters, digits, the dot character and the underline character.

LinkedIn URL

Twitter URL

Facebook URL

If true (1) then the employee will receive an SMS message informing them about new appointments

The SMS service to be used in the following format: number@sms-service.com. Note: the number keyword will be replaced with the employee's phone number before the SMS is sent.

Whether the employee is the owner of the company (the employee created at signup). By updating the value for a created employee, areas from permissions can be managed for (all - 1/own - 0) account(s)

Import calendar source type. Possible values: 0 - Not set 1 - Google 2 - Outlook or other public URL calendar source (ics) 3 - Exchange

Export calendar source type. Possible values: 0 - Not set 1 - Outlook 2 - Ical 3 - Google 4 - Yahoo 5 - MSN 6 - ICalDav

iCalendar public url used as import source.

iCalendar public url used as export source.

Lable(s) for different application sections. In order to set permission an employee must have a user(can_login - 1). Possible values: locations, providers, services, availability, appointments, get_widget, promote, clients, overview, calendar, settings, profile, account

1 - weekly/ 2 - Date interval

0 - Available/ 1 - Out of Office

The ID of the company that owns the location. Field is writable when entity is owned by child accounts.

Name of the location

Unique ID of the location

Description of the location

Whether this is the main location for the company (the location created on registration)

Address line 1

Address line 2

City

State

Zip

Country

Photo URL

Phone number

Email address

Website URL

The PayPal account used for payments for the appointments that are booked on this location. If empty, the company account will be used.

The ID of the time zone

The latitude of the location automatically calculated based on its address

The longitude of the location automatically calculated based on its address

The ID of the company that the service belongs to. Field is writable when entity is owned by child account

The name of the service

The duration of the service in minutes

Unique ID of the service

The description of the service

If true (1) then the appointments made for the service will be automatically confirmed. If false (0) then the appointments must be confirmed by the provider.

If true (1) the service will be an additional service, otherwise it will be a base service.

The minimum number of minutes between two adjacent appointments

The minimum number of hours the appointment has to be scheduled before the scheduled time

The maximum number of days the appointment has to be scheduled after the scheduled time

The minimum number of hours before the appointment until the client can cancel the appointment. If 0 the client cannot cancel the appointment.

The minimum number of hours before the appointment until the client can reschedule the appointment. If 0, the client cannot reschedule.

The minimum number of hours before the appointment until the client can reschedule the appointment. If 0, the client cannot reschedule.

Number of minutes. If this field has a value different than 0, then the clients can choose any start time (in increments equal to the value of the field) for their appointment in the availability zone. If the value of the field is 0, then the clients can select only predefined time slots for the appointments.

If true the service can only be performed on the schedule times. If true, availability can be added to the service through the schedule field

The service can only be performed on the following times. The set_schedule needs to be set to true for this field to be considered.

The price of the service

The minimum amount required for the payment to be valid

Whether or not to allow the client to skip the online payment and pay with cash

The number of appointments that can be scheduled in the same time slot.

The message sent to the client in the confirmation email (after the client verifies his/her email address)

The message displayed on the widget after the client books an appointments

The order number of the service

The time when the service was created

The date when the service starts to show up on the widget. If this field is null, then there will be no limit on the start date.

To set the field to null, set it to the empty string when updating the service.

The date when the service stops being displayed on the widget. If this field is null, then there will be no limit on the end date.

To set the field to null, set it to the empty string when updating the service.

If 0 the service will not appear on the widget.

0 - one-time event / 1 - weekly / 2 - monthly

a date string with the format day/month/year

the start hour in the day

a date string with the format day/month/year. Used only if repeat = 1 or repeat = 2

the end hour in the day

Offset value in seconds

Description

Mysql standard name

Short description

The ID of the company

The list of events. The currently supported events are:

1. appointment.created
2. appointment.updated
3. appointment.deleted
4. appointment.rescheduled
5. appointment.reminder
6. appointment.canceled
7. *

The "*" event means that you will subscribe to all currently supported events as well as future added events.

The ID of the company

Unique ID of the Webhook subscriber

The list of events

Unique ID of the Webhook event