Input fields[3]
| Field | Type |
|---|---|
Booking IDsRequired | array |
Requirements
SimplyBook.me requires an active account and OAuth client credentials, granted by signing in with your account to connect — both are set up on its own site.[3]https://simplybook.me
Get your SimplyBook.me credentials
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- Company LogintextRequired
The company login from the admin URL.
[1] - API KeypasswordRequired
Plugins → API → Settings. This is the API key, not the API secret.
[1] - User LogintextRequired
The admin user's login. Required for admin methods.
[1] - User Password or API User KeypasswordRequired
The user's password, or an API User Key that starts with
[1]api_user_key_. Use an API User Key when two-factor authentication is on. - API Secret Keypassword
Plugins → API → Settings, the secret key. Required only for signed public calls (confirm, client read).
[1]
Connect SimplyBook.me in WEXTL
- Log in to your WEXTL account, add the SimplyBook.me node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your SimplyBook.me account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
SimplyBook.me node modules
The list below is a reference of every SimplyBook.me node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every SimplyBook.me node module below — each one opens to show its input parameters, outputs, and connection requirements.
Calculate End TimeSearch
Input fields[3]
| Field | Type |
|---|---|
StartRequired | date |
ServiceRequired | choice |
ProviderRequired | choice |
| Product IDs | array |
Calculate End Time (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
StartRequired | date |
ServiceRequired | choice |
ProviderRequired | choice |
| Product IDs | array |
Check Client For InvoiceSearch
Input fields[3]
| Field | Type |
|---|---|
ClientRequired | text |
| Current client ID | text |
Filter Available UnitsSearch
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
Date and timeRequired | date |
ProvidersRequired | choice |
| Count | number |
| Product IDs | array |
Filter Available Units (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
Date and timeRequired | date |
ProvidersRequired | choice |
| Count | number |
| Product IDs | array |
1other input field
Get Additional Field ListSearch
No fields documented.
Get Additional FieldsSearch
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
| Modifiable only | choice |
Get Additional Fields (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
| Modifiable only | choice |
Get Allowed Payment SystemsSearch
No fields documented.
Get Any Unit DataSearch
Get Any Unit Data (Admin)Search
Get Application TokenSearch
Input fields[3]
| Field | Type |
|---|---|
Application API keyRequired | text |
Get Autocomplete SuggestionsSearch
Input fields[3]
| Field | Type |
|---|---|
| Search | text |
| Service name | text |
| Company name | text |
| Company address | text |
| Category | choice |
9other input fields
Get Available Time IntervalsSearch
Input fields[3]
| Field | Type |
|---|---|
FromRequired | date |
ToRequired | date |
| Service | choice |
| Providers | choice |
| Count | number |
Get Available Time Intervals (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
Date fromRequired | date |
Date toRequired | date |
| Service | choice |
| Provider | choice |
| Count | number |
Get Available UnitsSearch
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
Date and timeRequired | date |
| Count | number |
| Provider | choice |
| Product IDs | array |
1other input field
Get Available Units (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
Date and timeRequired | date |
| Count | number |
| Provider | choice |
| Product IDs | array |
1other input field
Get Bonus ReportSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
Get BookingSearch
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Booking hashRequired | text |
Get Booking Cancellations InfoSearch
Get Booking CartSearch
Get Booking Cart InfoSearch
Input fields[3]
| Field | Type |
|---|---|
Cart IDRequired | number |
Cart hashRequired | text |
Get Booking Cart Info With Zero PricesSearch
Input fields[3]
| Field | Type |
|---|---|
Cart IDRequired | text |
SignRequired | text |
Get Booking Cart Payment Page UrlSearch
Input fields[3]
| Field | Type |
|---|---|
Cart IDRequired | text |
Get Booking Cart StatusSearch
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Get Booking CommentSearch
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Get Booking DetailsSearch
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Booking hashRequired | text |
Get Booking Details (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Get Booking Details ZapierSearch
Input fields[3]
| Field | Type |
|---|---|
IDRequired | text |
LimitRequired | number |
Get Booking Details Zapier MockSearch
Input fields[3]
| Field | Type |
|---|---|
LimitRequired | number |
Get Booking Limit Unavailable Time IntervalSearch
Get Booking Online Meeting LinkSearch
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Get Booking ReportSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
LimitRequired | number |
Get Booking RevenueSearch
Input fields[3]
| Field | Type |
|---|---|
| Start date | date |
| End date | date |
| Provider | choice |
| Service | choice |
| Filter field | text |
Get Booking StatsSearch
Input fields[3]
| Field | Type |
|---|---|
| Group by | choice |
Get Booking StatusSearch
Input fields[3]
| Field | Type |
|---|---|
Booking IDRequired | number |
Get BookingsSearch
Input fields[3]
| Field | Type |
|---|---|
FilterRequired | object |
| Date from | date |
| Time from | time |
| Date to | date |
| Time to | time |
| Created from | date |
| Created to | date |
| Edited from | date |
| Edited to | date |
| Provider | choice |
| Service | choice |
Get Bookings ZapierSearch
No fields documented.
Get Campaign ListSearch
Input fields[3]
| Field | Type |
|---|---|
LimitRequired | number |
Get Campaign MetadataSearch
Input fields[3]
| Field | Type |
|---|---|
Campaign IDRequired | text |
Get Campaign StatisticsSearch
Input fields[3]
| Field | Type |
|---|---|
Campaign IDRequired | text |
Get Cancellation PolicySearch
No fields documented.
Get Cancellation Policy (Admin)Search
No fields documented.
Get Captcha ChallengeSearch
Output fields[3]
| Field | Type |
|---|---|
| Provider | text |
| WidgetUrl | text |
| Assets | text |
| ImageUrl | text |
Get CartSearch
Input fields[3]
| Field | Type |
|---|---|
Booking IDsRequired | array |
Payment processorRequired | text |
Get Cartesian Start Time MatrixSearch
Get Cartesian Start Time Matrix (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
FromRequired | date |
ToRequired | date |
ServiceRequired | choice |
| Provider | choice |
| Count | number |
3other input fields
Get CategoriesSearch
Get Categories ListSearch
Input fields[3]
| Field | Type |
|---|---|
| Public only | choice |
LimitRequired | number |
Get Categories List (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
| Public | choice |
LimitRequired | number |
Get CitiesSearch
Get Classes ListSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter | text |
Get Classes List (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
| Visible only | choice |
LimitRequired | number |
Get ClientSearch
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | text |
Get Client BookingsSearch
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | number |
SignRequired | text |
FilterRequired | object |
| Upcoming only | choice |
| Confirmed only | choice |
| Params | text |
LimitRequired | number |
Get Client By Login HashSearch
Input fields[3]
| Field | Type |
|---|---|
HashRequired | text |
| Set expired | choice |
| Expire other hashes | choice |
Get Client CommentsSearch
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | number |
| Booking ID | number |
Get Client InfoSearch
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | number |
Client hashRequired | text |
Get Client Info (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | text |
LimitRequired | number |
Get Client Info By Login PasswordSearch
Input fields[3]
| Field | Type |
|---|---|
LoginRequired | text |
PasswordRequired | secret |
Get Client Info By Open Id TokenSearch
Input fields[3]
| Field | Type |
|---|---|
TokenRequired | text |
ProviderRequired | text |
Get Client Info ZapierSearch
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | text |
LimitRequired | number |
Get Client Info Zapier MockSearch
Input fields[3]
| Field | Type |
|---|---|
LimitRequired | number |
Get Client ListSearch
Input fields[3]
| Field | Type |
|---|---|
| Search | text |
| Limit | number |
Get Client Membership ListSearch
Input fields[3]
| Field | Type |
|---|---|
FilterRequired | text |
Client IDRequired | number |
SignRequired | text |
Get Client Membership List (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | number |
Get Client ReportSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
LimitRequired | number |
Get Client Report IdsSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
Get Client Reviews LikesSearch
Input fields[3]
| Field | Type |
|---|---|
LoginRequired | text |
ClientRequired | text |
| Client provider | text |
Get Client Soap Crypt DataSearch
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | number |
LimitRequired | number |
Get Client Soap Crypt HistorySearch
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | number |
LimitRequired | number |
Get Client Soap DataSearch
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | number |
LimitRequired | number |
Get Client Soap HistorySearch
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | number |
LimitRequired | number |
Get Client Wait Listing BookingsSearch
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | text |
SignRequired | text |
FilterRequired | text |
Get Company CountSearch
Input fields[3]
| Field | Type |
|---|---|
| Search | text |
| Service name | text |
| Company name | text |
| Company address | text |
| Tags | choice |
7other input fields
Get Company CurrencySearch
No fields documented.
Get Company InfoSearch
No fields documented.
Get Company Info (Admin)Search
No fields documented.
Get Company Info (Catalog)Search
Input fields[3]
| Field | Type |
|---|---|
LoginRequired | text |
Get Company Intersected VacationsSearch
Input fields[3]
| Field | Type |
|---|---|
Date fromRequired | date |
Date toRequired | date |
LimitRequired | number |
Get Company ListSearch
Input fields[3]
| Field | Type |
|---|---|
| Search | text |
| Service name | text |
| Company name | text |
| Company address | text |
| Category | choice |
8other input fields
Get Company MarkersSearch
Input fields[3]
| Field | Type |
|---|---|
FilterRequired | text |
BoundsRequired | array |
ZoomRequired | number |
| Clustering | choice |
LimitRequired | number |
Get Company ParamSearch
Input fields[3]
| Field | Type |
|---|---|
KeyRequired | text |
Get Company Param (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
KeyRequired | text |
Get Company ParamsSearch
Input fields[3]
| Field | Type |
|---|---|
KeysRequired | array |
Get Company Params (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
KeysRequired | array |
Get Company Promotion ListSearch
Input fields[3]
| Field | Type |
|---|---|
Company loginRequired | text |
| Count | number |
LimitRequired | number |
Get Company ReviewSearch
Input fields[3]
| Field | Type |
|---|---|
LoginRequired | text |
ReviewRequired | number |
Get Company ReviewsSearch
Get Company Reviews CountSearch
Input fields[3]
| Field | Type |
|---|---|
LoginRequired | text |
Get Company Timezone OffsetSearch
Input fields[3]
| Field | Type |
|---|---|
LimitRequired | number |
Get Company Timezone Offset (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
LimitRequired | number |
Get Company VacationSearch
Input fields[3]
| Field | Type |
|---|---|
Vacation IDRequired | number |
LimitRequired | number |
Get Company VacationsSearch
Input fields[3]
| Field | Type |
|---|---|
LimitRequired | number |
Get Company Work Calendar For YearSearch
Input fields[3]
| Field | Type |
|---|---|
YearRequired | number |
Get Contact Widget ReportSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
Get Count by Scheduler ChannelsSearch
Input fields[3]
| Field | Type |
|---|---|
Start dateRequired | date |
End dateRequired | date |
LimitRequired | number |
Get Countries (Admin)Search
No fields documented.
Get Countries (Catalog)Search
Get Country ListSearch
No fields documented.
Get Country Phone CodesSearch
No fields documented.
Get Country Phone Codes (Admin)Search
No fields documented.
Get Current Tariff InfoSearch
No fields documented.
Get Current User DetailsSearch
No fields documented.
Get Email ReportSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
LimitRequired | number |
Get Event ListSearch
Get Event List (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
| Visible only | choice |
| Classes | choice |
| Search | text |
LimitRequired | number |
Get Feedback ListSearch
Input fields[3]
| Field | Type |
|---|---|
LimitRequired | number |
Get Feedback ReportSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
LimitRequired | number |
Get FeedbacksSearch
Input fields[3]
| Field | Type |
|---|---|
| Approved only | choice |
| Reviews only | choice |
| Last only | choice |
| Limit | number |
Get First Working DaySearch
Input fields[3]
| Field | Type |
|---|---|
| Schedule | object |
| Provider | choice |
| Service | choice |
Get First Working Day (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
| Data | text |
Get Google Calendar Busy TimeSearch
Input fields[3]
| Field | Type |
|---|---|
StartRequired | date |
EndRequired | date |
ProviderRequired | choice |
Get Google Calendar Busy Time Available UnitsSearch
No fields documented.
Get Invoice DetailsSearch
Input fields[3]
| Field | Type |
|---|---|
IDRequired | text |
LimitRequired | number |
Get Invoice Details MockSearch
Input fields[3]
| Field | Type |
|---|---|
LimitRequired | number |
Get Last Notification UpdateSearch
Input fields[3]
| Field | Type |
|---|---|
TypeRequired | text |
Get Locations ListSearch
Input fields[3]
| Field | Type |
|---|---|
| Public only | choice |
LimitRequired | number |
Get Locations List (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
| Public | choice |
LimitRequired | number |
Get MembershipSearch
Input fields[3]
| Field | Type |
|---|---|
Membership IDRequired | number |
Get Membership ListSearch
No fields documented.
Get Membership List (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
| Visible memberships only | choice |
LimitRequired | number |
Get Membership List For ComboboxSearch
Input fields[3]
| Field | Type |
|---|---|
| Search | text |
| Limit | text |
| Visible memberships only | choice |
Get Notification Config StructureSearch
Input fields[3]
| Field | Type |
|---|---|
| Plugin | text |
Get Object MetafieldSearch
Input fields[3]
| Field | Type |
|---|---|
IDRequired | text |
TypeRequired | text |
Get Payment Processor ConfigSearch
Input fields[3]
| Field | Type |
|---|---|
Payment processorRequired | text |
Get Payment RequirementSearch
Input fields[3]
| Field | Type |
|---|---|
| Service | choice |
Get Paypal InformationSearch
No fields documented.
Get Pending Booking CountSearch
No fields documented.
Get Pending BookingsSearch
No fields documented.
Get Performer Intersected VacationsSearch
Input fields[3]
| Field | Type |
|---|---|
Date fromRequired | date |
Date toRequired | date |
ProviderRequired | choice |
LimitRequired | number |
Get Performer VacationSearch
Input fields[3]
| Field | Type |
|---|---|
Vacation IDRequired | number |
ProviderRequired | choice |
Get Performer VacationsSearch
Input fields[3]
| Field | Type |
|---|---|
ProviderRequired | choice |
Get Performer Work Calendar For YearSearch
Input fields[3]
| Field | Type |
|---|---|
YearRequired | text |
ProviderRequired | choice |
Get Plugin ListSearch
Input fields[3]
| Field | Type |
|---|---|
| Extended info | text |
Get Plugin StatusSearch
Input fields[3]
| Field | Type |
|---|---|
PluginRequired | text |
Get Plugin Status (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
Plugin nameRequired | text |
Get Plugin StatusesSearch
Input fields[3]
| Field | Type |
|---|---|
PluginsRequired | array |
Get Plugin Statuses (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
Plugin namesRequired | array |
Get Pos ReportSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
Get Privacy Policy TextSearch
No fields documented.
Get Product Categories ListSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter | text |
Get Product Categories List (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
| Filter | text |
Get Product ListSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter | object |
| Service | choice |
LimitRequired | number |
Get Product List (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
| Filter | text |
Get Promocode InfoSearch
Input fields[3]
| Field | Type |
|---|---|
CodeRequired | text |
Get Promotion CountSearch
Input fields[3]
| Field | Type |
|---|---|
| Search | text |
| Service name | text |
| Company name | text |
| Company address | text |
| Tags | choice |
7other input fields
Get Promotion DetailsSearch
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Get Promotion InfoSearch
Input fields[3]
| Field | Type |
|---|---|
PromotionRequired | number |
| Feedback from | number |
| Feedback count | number |
Get Promotion Info by CodeSearch
Input fields[3]
| Field | Type |
|---|---|
CodeRequired | text |
Get Promotion Info by Code (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
CodeRequired | text |
Get Promotion InstanceSearch
Input fields[3]
| Field | Type |
|---|---|
Promotion instance IDRequired | text |
Get Promotion Instance ListSearch
Input fields[3]
| Field | Type |
|---|---|
| Promotion type | choice |
LimitRequired | number |
Get Promotion Instance ReportSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
Get Promotion List (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
| Visible only | choice |
| Promotion type | choice |
LimitRequired | number |
Get Promotion List (Catalog)Search
Input fields[3]
| Field | Type |
|---|---|
| Search | text |
| Service name | text |
| Company name | text |
| Company address | text |
| Tags | choice |
7other input fields
Get Promotion List By IdsSearch
Input fields[3]
| Field | Type |
|---|---|
Promotion idsRequired | array |
LimitRequired | number |
Get Promotion MarkersSearch
Input fields[3]
| Field | Type |
|---|---|
FilterRequired | text |
BoundsRequired | array |
ZoomRequired | number |
| Clustering | choice |
LimitRequired | number |
Get Promotion ReviewsSearch
Input fields[3]
| Field | Type |
|---|---|
PromotionRequired | number |
Get Promotion Reward InfoSearch
Input fields[3]
| Field | Type |
|---|---|
Promotion IDRequired | number |
Client IDRequired | number |
HashRequired | text |
Get Push Notifications ReportSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
Get Pwa Client ReportSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
Get Pwa Push ReportSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
Get Pwa User Device InfoSearch
No fields documented.
Get Recent ActionsSearch
Input fields[3]
| Field | Type |
|---|---|
| Last only | choice |
| Limit | number |
Get Recent CompaniesSearch
Input fields[3]
| Field | Type |
|---|---|
CountRequired | number |
LimitRequired | number |
Get Recent FeedbacksSearch
Input fields[3]
| Field | Type |
|---|---|
CountRequired | number |
LimitRequired | number |
Get Recent PromotionsSearch
Input fields[3]
| Field | Type |
|---|---|
CountRequired | number |
LimitRequired | number |
Get Recurring DatetimesSearch
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
ProviderRequired | choice |
DateRequired | date |
TimeRequired | time |
| Recurring | text |
4other input fields
Get Recurring Datetimes (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
ProviderRequired | choice |
DateRequired | date |
TimeRequired | time |
| Recurring data | text |
2other input fields
Get Recurring SettingsSearch
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
Get RegistrationsSearch
Input fields[3]
| Field | Type |
|---|---|
| Group by | choice |
Get Related PromotionsSearch
Input fields[3]
| Field | Type |
|---|---|
PromotionRequired | number |
| Count | number |
LimitRequired | number |
Get Reserved TimeSearch
Input fields[3]
| Field | Type |
|---|---|
FromRequired | date |
ToRequired | date |
ServiceRequired | choice |
| Provider | choice |
| Count | number |
Get Reserved Time (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
FromRequired | date |
ToRequired | date |
ServiceRequired | choice |
| Provider | choice |
| Count | number |
Get Reserved Time IntervalsSearch
Input fields[3]
| Field | Type |
|---|---|
FromRequired | date |
ToRequired | date |
ServiceRequired | choice |
| Providers | choice |
| Count | number |
1other input field
Get Reserved Time Intervals (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
Date fromRequired | date |
Date toRequired | date |
ServiceRequired | choice |
| Providers | choice |
| Count | number |
1other input field
Get Service Available Time IntervalsSearch
Input fields[3]
| Field | Type |
|---|---|
FromRequired | date |
ToRequired | date |
| Services | choice |
| Provider | choice |
| Count | number |
Get Service Available Time Intervals (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
Date fromRequired | date |
Date toRequired | date |
| Services | choice |
| Provider | choice |
| Count | number |
Get Service Intersected VacationsSearch
Input fields[3]
| Field | Type |
|---|---|
Date fromRequired | date |
Date toRequired | date |
ServiceRequired | choice |
Get Service UrlSearch
Input fields[3]
| Field | Type |
|---|---|
Company loginRequired | text |
Get Service VacationSearch
Input fields[3]
| Field | Type |
|---|---|
Vacation IDRequired | number |
ServiceRequired | choice |
Get Service VacationsSearch
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
Get Service Work Calendar For YearSearch
Input fields[3]
| Field | Type |
|---|---|
YearRequired | number |
ServiceRequired | choice |
Get Sms GatewaysSearch
No fields documented.
Get Sms ReportSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
Get Social Counter StatsSearch
Input fields[3]
| Field | Type |
|---|---|
ProviderRequired | text |
Get Start Time MatrixSearch
Input fields[3]
| Field | Type |
|---|---|
FromRequired | date |
ToRequired | date |
ServiceRequired | choice |
| Providers | choice |
| Count | number |
2other input fields
Get Start Time Matrix (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
FromRequired | date |
ToRequired | date |
ServiceRequired | choice |
| Providers | choice |
| Count | number |
2other input fields
Get State ListSearch
No fields documented.
Get StatesSearch
No fields documented.
Get Static PageSearch
Input fields[3]
| Field | Type |
|---|---|
IDRequired | text |
| Show hidden | text |
Get Static Page ListSearch
No fields documented.
Get StatusesSearch
No fields documented.
Get TagsSearch
Get Tags ListSearch
No fields documented.
Get the Filtered PWA MenuSearch
Input fields[3]
| Field | Type |
|---|---|
MenuRequired | text |
Get Ticket ReportSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
Get TimeframeSearch
No fields documented.
Get Timeframe (Admin)Search
No fields documented.
Get Timeline TypeSearch
No fields documented.
Get Timeline Type (Admin)Search
No fields documented.
Get Top CitiesSearch
Get Top CountriesSearch
Get Top PerformersSearch
No fields documented.
Get Top ServicesSearch
Input fields[3]
| Field | Type |
|---|---|
| Date start | date |
| Date end | date |
Get Unit ListSearch
Get Unit List (Admin)Search
Get Unit Workday InfoSearch
Input fields[3]
| Field | Type |
|---|---|
Date startRequired | date |
Date endRequired | date |
| Provider | choice |
Get Unit Working DurationsSearch
Input fields[3]
| Field | Type |
|---|---|
| Date start | date |
| Date end | date |
| Provider | choice |
Get Upcoming Promotion AvailabilitySearch
No fields documented.
Get User Google Auth InfoSearch
Input fields[3]
| Field | Type |
|---|---|
User IDRequired | text |
| Is Change | choice |
Get User License TextSearch
No fields documented.
Get User LocationSearch
Input fields[3]
| Field | Type |
|---|---|
| IP address | text |
Get User Phone Validation InfoSearch
Get Visitor StatsSearch
Input fields[3]
| Field | Type |
|---|---|
| Group by | text |
Get Waiting List Booking ReportSearch
Input fields[3]
| Field | Type |
|---|---|
RequestRequired | text |
Get WarningsSearch
Input fields[3]
| Field | Type |
|---|---|
| Last only | choice |
Get Work CalendarSearch
Input fields[3]
| Field | Type |
|---|---|
YearRequired | number |
MonthRequired | number |
| Schedule | object |
| Provider | choice |
| Service | choice |
Get Work Calendar (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
YearRequired | number |
MonthRequired | number |
| Data | text |
Get Work Days InfoSearch
Input fields[3]
| Field | Type |
|---|---|
FromRequired | date |
ToRequired | date |
| Provider | choice |
| Service | choice |
| Count | number |
1other input field
Get Work Days Info (Admin)Search
Input fields[3]
| Field | Type |
|---|---|
FromRequired | date |
ToRequired | date |
| Provider | choice |
| Service | choice |
| Count | number |
1other input field
Get Work Days TimesSearch
Input fields[3]
| Field | Type |
|---|---|
Start datetimeRequired | text |
End datetimeRequired | text |
| Schedule type | choice |
Get WorkloadSearch
Input fields[3]
| Field | Type |
|---|---|
| Date start | date |
| Date end | date |
| Provider | choice |
Add a Client Without LoginAction
Input fields[3]
| Field | Type |
|---|---|
DataRequired | text |
| Client ID | number |
| Client sign | text |
Add ClientAction
Input fields[3]
| Field | Type |
|---|---|
DataRequired | text |
Add Client (Admin)Action
Input fields[3]
| Field | Type |
|---|---|
ClientRequired | object |
NameRequired | text |
| text | |
| Phone | text |
| Address 1 | text |
| Address 2 | text |
| City | text |
| ZIP | text |
| Country ID | text |
| Email unsubscribed | choice |
| SMS unsubscribed | choice |
| Send email | choice |
Add Company ReviewAction
Input fields[3]
| Field | Type |
|---|---|
LoginRequired | text |
SubjectRequired | text |
MessageRequired | text |
RateRequired | number |
ProviderRequired | text |
2other input fields
Add Company Review With IdAction
Input fields[3]
| Field | Type |
|---|---|
LoginRequired | text |
SubjectRequired | text |
MessageRequired | text |
RateRequired | number |
ProviderRequired | text |
2other input fields
Add Contact MessageAction
Input fields[3]
| Field | Type |
|---|---|
DataRequired | text |
Add Device TokenAction
Input fields[3]
| Field | Type |
|---|---|
TokenRequired | text |
DeviceRequired | text |
Add Plugin Data To Provider ListAction
Input fields[3]
| Field | Type |
|---|---|
ProvidersRequired | text |
| Visible only | choice |
Add Plugin Data To Provider List (Admin)Action
Input fields[3]
| Field | Type |
|---|---|
UnitsRequired | text |
| Visible only | choice |
LimitRequired | number |
Add Plugin Data To Service ListAction
Input fields[3]
| Field | Type |
|---|---|
ServicesRequired | text |
| Visible only | choice |
Add Plugin Data To Service List (Admin)Action
Input fields[3]
| Field | Type |
|---|---|
EventsRequired | text |
| Visible only | choice |
LimitRequired | number |
Add Promotion ReviewAction
Input fields[3]
| Field | Type |
|---|---|
PromotionRequired | number |
SubjectRequired | text |
MessageRequired | text |
RateRequired | number |
ProviderRequired | text |
1other input field
Add ServiceAction
Input fields[3]
| Field | Type |
|---|---|
DataRequired | text |
Add Service CategoryAction
Input fields[3]
| Field | Type |
|---|---|
DataRequired | text |
Add Service ProviderAction
Input fields[3]
| Field | Type |
|---|---|
DataRequired | text |
Add Service Provider LocationAction
Input fields[3]
| Field | Type |
|---|---|
DataRequired | text |
Add To Waiting ListAction
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
ProviderRequired | choice |
DateRequired | date |
TimeRequired | time |
ClientRequired | text |
2other input fields
Apply Promo CodeAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
CodeRequired | text |
LimitRequired | number |
Apply TipAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
| Percent | number |
| Amount | number |
LimitRequired | number |
Approve a Pending BookingAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Cancel a ClassPass BookingAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | text |
ClassPass signRequired | text |
| Reason | text |
Cancel a Pending BookingAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Cancel BatchAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | text |
BookingsRequired | text |
| Reason | text |
Cancel Batch (Admin)Action
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Booking IDsRequired | array |
Cancel BookingAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | text |
SignRequired | text |
| Reason | text |
Cancel Booking (Admin)Action
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Change a Client PasswordAction
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | number |
PasswordRequired | secret |
Send emailRequired | choice |
Close a Booking BatchAction
Input fields[3]
| Field | Type |
|---|---|
Batch IDRequired | text |
Batch typeRequired | text |
SignRequired | text |
Confirm BookingAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Booking hashRequired | text |
Confirm Booking BatchAction
Input fields[3]
| Field | Type |
|---|---|
Batch IDRequired | number |
Batch typeRequired | text |
Batch hashRequired | text |
Confirm Booking Batch PaymentAction
Input fields[3]
| Field | Type |
|---|---|
Batch IDRequired | text |
Batch typeRequired | text |
Payment processorRequired | text |
SignRequired | text |
Confirm Booking CartAction
Input fields[3]
| Field | Type |
|---|---|
Cart IDRequired | number |
Payment processorRequired | text |
Cart hashRequired | text |
Confirm Booking PaymentAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Payment processorRequired | text |
Booking hashRequired | text |
Confirm CampaignAction
Input fields[3]
| Field | Type |
|---|---|
Campaign IDRequired | text |
Confirm InvoiceAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Payment systemRequired | text |
LimitRequired | number |
Create a BookingAction
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
ProviderRequired | choice |
DateRequired | date |
TimeRequired | time |
ClientRequired | object |
NameRequired | text |
| Phone | text |
| Client time offset | number |
4other input fields
Create a Booking (Admin)Action
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
ProviderRequired | choice |
Client IDRequired | number |
Start dateRequired | date |
Start timeRequired | time |
7other input fields
Create a Booking BatchAction
No fields documented.
Create a Booking Batch (Admin)Action
No fields documented.
Create a Client Sign-UpAction
Input fields[3]
| Field | Type |
|---|---|
DataRequired | text |
Create a Membership PaymentAction
Input fields[3]
| Field | Type |
|---|---|
Membership IDRequired | text |
Client IDRequired | text |
Start dateRequired | date |
SignRequired | text |
Delete Additional FieldsAction
Input fields[3]
| Field | Type |
|---|---|
Additional fieldsRequired | array |
Delete CampaignAction
Input fields[3]
| Field | Type |
|---|---|
IDsRequired | text |
Delete CategoriesAction
Input fields[3]
| Field | Type |
|---|---|
CategoriesRequired | array |
Delete ClassesAction
Input fields[3]
| Field | Type |
|---|---|
ClassesRequired | array |
Delete Client FeedbacksAction
Input fields[3]
| Field | Type |
|---|---|
Client dataRequired | array |
Delete Client Promotion FeedbacksAction
Input fields[3]
| Field | Type |
|---|---|
Client dataRequired | array |
Delete Company VacationAction
Input fields[3]
| Field | Type |
|---|---|
Vacation IDRequired | number |
Delete Device TokenAction
Input fields[3]
| Field | Type |
|---|---|
TokenRequired | text |
Delete LocationsAction
Input fields[3]
| Field | Type |
|---|---|
LocationsRequired | array |
Delete MembershipsAction
Input fields[3]
| Field | Type |
|---|---|
MembershipsRequired | array |
Delete Object MetafieldAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | text |
TypeRequired | text |
Delete Performer VacationAction
Input fields[3]
| Field | Type |
|---|---|
Vacation IDRequired | number |
ProviderRequired | choice |
Delete PerformersAction
Input fields[3]
| Field | Type |
|---|---|
PerformersRequired | array |
Delete ProductAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | text |
Delete Product CategoryAction
Input fields[3]
| Field | Type |
|---|---|
Category IDRequired | text |
LimitRequired | number |
Delete Promotion InstancesAction
Input fields[3]
| Field | Type |
|---|---|
InstancesRequired | array |
Delete PromotionsAction
Input fields[3]
| Field | Type |
|---|---|
PromotionsRequired | array |
Delete Service CategoryAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Delete Service Provider LocationAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
Delete Service VacationAction
Input fields[3]
| Field | Type |
|---|---|
Vacation IDRequired | number |
ServiceRequired | choice |
Delete ServicesAction
Input fields[3]
| Field | Type |
|---|---|
ServicesRequired | array |
Delete Special DayAction
Input fields[3]
| Field | Type |
|---|---|
DateRequired | date |
| Filter | object |
| Provider | choice |
| Service | choice |
Delete Static PagesAction
Input fields[3]
| Field | Type |
|---|---|
IDsRequired | text |
Delete User Google Auth ConnectionAction
Input fields[3]
| Field | Type |
|---|---|
User IDRequired | text |
LimitRequired | number |
Disable Promotion InstancesAction
Input fields[3]
| Field | Type |
|---|---|
InstancesRequired | array |
Edit a BookingAction
Input fields[3]
| Field | Type |
|---|---|
Booking IDRequired | number |
ServiceRequired | choice |
ProviderRequired | choice |
Client IDRequired | number |
Start dateRequired | date |
5other input fields
Edit ClientAction
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | number |
ClientRequired | object |
| Name | text |
| text | |
| Phone | text |
| Address 1 | text |
| Address 2 | text |
| City | text |
| ZIP | text |
| Country ID | text |
| Email unsubscribed | choice |
| SMS unsubscribed | choice |
Edit ServiceAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
DataRequired | text |
Edit Service CategoryAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
DataRequired | text |
Edit Service ProviderAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
DataRequired | text |
Edit Service Provider LocationAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
DataRequired | text |
Make an API Calluniversal
Input fields[3]
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query string | array |
| Parameter | object |
| Body | text |
Modify Client InfoAction
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | number |
DataRequired | text |
Client hashRequired | text |
Modify Client PasswordAction
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | number |
DataRequired | text |
SignRequired | text |
Regenerate Google Auth CodesAction
Input fields[3]
| Field | Type |
|---|---|
User IDRequired | text |
Remove a Notification SubscriptionAction
Input fields[3]
| Field | Type |
|---|---|
URLRequired | url |
Reset Client PasswordsAction
Input fields[3]
| Field | Type |
|---|---|
Client IDsRequired | array |
Send a Client Password ReminderAction
Input fields[3]
| Field | Type |
|---|---|
EmailRequired |
Send a Client Sign-Up EmailAction
Input fields[3]
| Field | Type |
|---|---|
ClientRequired | text |
Send Clients PasswordAction
Input fields[3]
| Field | Type |
|---|---|
EmailRequired | text |
Send Promotion MessagesAction
Input fields[3]
| Field | Type |
|---|---|
DataRequired | text |
Set Booking CommentAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | number |
CommentRequired | text |
Set Categories PositionsAction
Input fields[3]
| Field | Type |
|---|---|
Categories PositionsRequired | array |
Set Category EventsAction
Input fields[3]
| Field | Type |
|---|---|
Category IDRequired | number |
ServicesRequired | array |
Set Classes PositionsAction
Input fields[3]
| Field | Type |
|---|---|
Classes PositionsRequired | array |
| Category ID | number |
Set Classes VisibilityAction
Input fields[3]
| Field | Type |
|---|---|
Classes VisibilityRequired | array |
Set Event CategoriesAction
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
CategoriesRequired | array |
Set Event Unit GroupsAction
Input fields[3]
| Field | Type |
|---|---|
ServiceRequired | choice |
ProvidersRequired | array |
Set Location Unit GroupsAction
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | number |
ProvidersRequired | array |
Set Locations PositionsAction
Input fields[3]
| Field | Type |
|---|---|
PositionsRequired | array |
Set Object MetafieldAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | text |
TypeRequired | text |
DataRequired | text |
Set Performers PositionsAction
Input fields[3]
| Field | Type |
|---|---|
Performers PositionsRequired | array |
| Location ID | number |
Set Product CategoriesAction
Input fields[3]
| Field | Type |
|---|---|
Product IDRequired | text |
CategoriesRequired | text |
Set Product Category PositionsAction
Input fields[3]
| Field | Type |
|---|---|
Categories PositionsRequired | text |
Set Product PositionsAction
Input fields[3]
| Field | Type |
|---|---|
PositionsRequired | text |
| Type | text |
| Category ID | text |
Set Promotion EventsAction
Input fields[3]
| Field | Type |
|---|---|
Promotion IDRequired | number |
ServicesRequired | array |
…and 48 more modules
Templates
Look for SimplyBook.me templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Anny Customer API[2]Online booking and scheduling platform that lets customers book resources, services, and appointments in real time.
- BookedSchedulerResource reservation and scheduling platform for booking rooms, equipment, and shared assets.
- BookeoOnline booking and appointment scheduling platform for tours, classes, and service businesses.
- Anny Admin APIOnline booking and scheduling platform for managing services, resources, timeslots, and customer appointments.
- AmeliaWordPress booking and appointment scheduling for services and events.
References
- WEXTL® SimplyBook.me Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for SimplyBook.me.
- WEXTL® visual workflow builder data.
Last updated: Oct 4, 2026 23:06