Jump to Content

Guides API Reference Customer Help Center

Home Guides Recipes API Reference Changelog

Guides API Reference Customer Help Center Log In

API Reference

The Xola API

Payment Methods
Booking Sources
Metadata
Query Language
Triggers and Rewards

Experiences

Introduction
List categoriesget
Create an Experiencepost
Retrieve an experienceget
Update an Experienceput
Remove an experiencedelete
List experiencesget
Add-Ons
Attachments
Media
Review Preferences
[W] Schedules
Terms & Conditions
SCHEDULES
- Create a schedulepost

Packages

Introduction
Create a packagepost
Update a packageput
Retrieve a packageget
Delete a packagedelete
List all packagesget
[X] Media

Forms

Introduction
Create a formpost
Retrieve a formget
Update a formput
List all formsget
Delete a formdelete
Retrieve the form for an orderget

Demographics

Introduction
Create an experience demographicpost
Update an experience demographicput
Delete an experience demographicdelete
Create a seller demographicpost
Update a seller demographicput
Delete a seller demographicdelete
Retrieve a demographicget
List all demographicsget

Resources (Inventory)

[W] Introduction
[W] Create a resourcepost
[W] Retrieve a resourceget
[U] Assign a resource to an experiencepost
[U] Un-assign a resource from an experiencedelete
Update a resourceput
Delete a resourcedelete

Availability

Introduction
Experience availabilityget
Batch availabilityget
Event capacityget

Buttons

Introduction
Create a buttonpost
Retrieve a buttonget
Update a buttonput
Archive a buttondelete
List all buttonsget

Coupons

Introduction
[R] Create a couponpost
[U] Retrieve a couponget
[R] Update a couponput
[U] Delete a coupondelete
[W] List all couponsget
Coupon Codes

Affiliates

[W] Introduction
Create an affiliatepost
[W] Update an affiliateput
Retrieve an affiliateget
Remove an affiliatedelete
[W] List all affiliatesget
Pay an affiliatepost
[!] Collect payment from an affiliatepost

Orders (Bookings)

Introduction
Prepare an orderpost
Create a new Orderpost
Retrieve an orderget
List all ordersget
Adjustments
Guest Data
Tags
- Add a tagpost
- Remove a tagdelete

Gifts

Introduction
Create a Giftpost
Retrieve a Giftget
List all Giftsget
Decrease Balancepost
Increase Balancepost
Add Fundspost
Refund Paymentpost

Transactions

Introduction
Retrieve a Transansactionget
List Transactionsget

Guides

Create a guidepost
Retrieve a guideget
Update a guideput
Delete a guidedelete
List all guidesget

Events

Introduction
Create an eventpost
Retrieve an eventget
Update an eventput
List all eventsget
Guides
Notes
- Create an event notepost
- Update an event noteput

Users

Introduction
Credit Cards
Preferences

Conversations

[W] Introduction
List all conversations

Account Settings

Blackout Schedules
Payment Methods
Review Preferences
Terms & Conditions

Languages

Introduction
List supported languagespost

Webhooks

Introduction
Retrieve a Webhookget
Subscribe to a webhookpost
Unsubscribe from a webhookdelete

Xola App Store

Plugins
Installations
- Retrieve an Installationget

Powered by

The Xola API

Payment Methods
Booking Sources
Metadata
Query Language
Triggers and Rewards

Experiences

Introduction
List categoriesget
Create an Experiencepost
Retrieve an experienceget
Update an Experienceput
Remove an experiencedelete
List experiencesget
Add-Ons
Attachments
Media
Review Preferences
[W] Schedules
Terms & Conditions
SCHEDULES
- Create a schedulepost

Packages

Introduction
Create a packagepost
Update a packageput
Retrieve a packageget
Delete a packagedelete
List all packagesget
[X] Media

Forms

Introduction
Create a formpost
Retrieve a formget
Update a formput
List all formsget
Delete a formdelete
Retrieve the form for an orderget

Demographics

Introduction
Create an experience demographicpost
Update an experience demographicput
Delete an experience demographicdelete
Create a seller demographicpost
Update a seller demographicput
Delete a seller demographicdelete
Retrieve a demographicget
List all demographicsget

Resources (Inventory)

[W] Introduction
[W] Create a resourcepost
[W] Retrieve a resourceget
[U] Assign a resource to an experiencepost
[U] Un-assign a resource from an experiencedelete
Update a resourceput
Delete a resourcedelete

Availability

Introduction
Experience availabilityget
Batch availabilityget
Event capacityget

Buttons

Introduction
Create a buttonpost
Retrieve a buttonget
Update a buttonput
Archive a buttondelete
List all buttonsget

Coupons

Introduction
[R] Create a couponpost
[U] Retrieve a couponget
[R] Update a couponput
[U] Delete a coupondelete
[W] List all couponsget
Coupon Codes

Affiliates

[W] Introduction
Create an affiliatepost
[W] Update an affiliateput
Retrieve an affiliateget
Remove an affiliatedelete
[W] List all affiliatesget
Pay an affiliatepost
[!] Collect payment from an affiliatepost

Orders (Bookings)

Introduction
Prepare an orderpost
Create a new Orderpost
Retrieve an orderget
List all ordersget
Adjustments
Guest Data
Tags
- Add a tagpost
- Remove a tagdelete

Gifts

Introduction
Create a Giftpost
Retrieve a Giftget
List all Giftsget
Decrease Balancepost
Increase Balancepost
Add Fundspost
Refund Paymentpost

Transactions

Introduction
Retrieve a Transansactionget
List Transactionsget

Guides

Create a guidepost
Retrieve a guideget
Update a guideput
Delete a guidedelete
List all guidesget

Events

Introduction
Create an eventpost
Retrieve an eventget
Update an eventput
List all eventsget
Guides
Notes
- Create an event notepost
- Update an event noteput

Users

Introduction
Credit Cards
Preferences

Conversations

[W] Introduction
List all conversations

Account Settings

Blackout Schedules
Payment Methods
Review Preferences
Terms & Conditions

Languages

Introduction
List supported languagespost

Webhooks

Introduction
Retrieve a Webhookget
Subscribe to a webhookpost
Unsubscribe from a webhookdelete

Xola App Store

Plugins
Installations
- Retrieve an Installationget

Powered by

Unsubscribe from a webhook

delete https://sandbox.xola.com/api/users/{userId}/hooks/{hookId}

Language

Credentials

Header

Click Try It! to start a request and see the response here!