Jump to Content

Guides Recipes API Reference API Changelog

API Reference

Guides Recipes API Reference API Changelog

Authentication

Access Tokens

Centers

Center APIs
- List all centersget
- Retrieve a centerget
Center - Categories
- List all categoriesget
- Retrieve a categoryget
Center - Rooms
- List all rooms of a centerget
- Retrieve a room of a centerget
Center - Employees
Center - Services
Center - Packages
- List all packages of a centerget
Center - Products
- List all products of a centerget
Center - Memberships
- List all memberships in a centerget
- Retrieve the details of all the members of a centerget

Guests

Guest APIs
Guest Notes
Guest Form
Guest Memberships
Guest Password

Employees

Employee APIs
BlockOut Times
Security Roles
- Add the security role for an employeepost
- Retrieve security roles of an employeeget

Rooms

BlockOut Times

Service Booking

Service Booking APIs

Gift Cards

Gift Card APIs
Gift Card Templates

Opportunities

Opportunities APIs
Notes
- Add notes to an opportunitypost
- List the notes of an opportunityget

Appointments

Appointment APIs

Organizations

Organization APIs

Reports

Reports APIs

Vendors

Vendor APIs
- Retrieve the list of all vendors for an organizationget
- Retrieve the list of all products associated to a vendorget

Inventory

Inventory APIs

Classes

Registration
Operations
Consumer
Metrics

Shopify

Shopify APIs
- Generate Shopify Multipass URLget

Invoices

Invoice APIs
Group Invoices
- Create a group invoicepost
- Send a group invoice emailpost
Membership Invoices
Product Invoices
Package Invoices
- Ability to redeem Series Regular Package in APIpost
- Ability to Sell Series Regular Packages in APIpost
Invoice Payments

Queue

Queue APIs

Webhook Events

Webhook Events
Invoice Events
- Invoice Closed
Guest Events
Classes Schedule Events
Classes Booking Events
Guest Membership Events
Appointment Events
- Appointment Started
- Appointment Completed
Appointment Feedback Event
- Feedback Started (Feedback V2)
- Feedback Started (Feedback V1)
Appointment Group Events
- Appointment Group Created
- Appointment Group Status
Employee Events
Guest Package Events

Authentication

Access Tokens

Centers

Center APIs
- List all centersget
- Retrieve a centerget
Center - Categories
- List all categoriesget
- Retrieve a categoryget
Center - Rooms
- List all rooms of a centerget
- Retrieve a room of a centerget
Center - Employees
Center - Services
Center - Packages
- List all packages of a centerget
Center - Products
- List all products of a centerget
Center - Memberships
- List all memberships in a centerget
- Retrieve the details of all the members of a centerget

Guests

Guest APIs
Guest Notes
Guest Form
Guest Memberships
Guest Password

Employees

Employee APIs
BlockOut Times
Security Roles
- Add the security role for an employeepost
- Retrieve security roles of an employeeget

Rooms

BlockOut Times

Service Booking

Service Booking APIs

Gift Cards

Gift Card APIs
Gift Card Templates

Opportunities

Opportunities APIs
Notes
- Add notes to an opportunitypost
- List the notes of an opportunityget

Appointments

Appointment APIs

Organizations

Organization APIs

Reports

Reports APIs

Vendors

Vendor APIs
- Retrieve the list of all vendors for an organizationget
- Retrieve the list of all products associated to a vendorget

Inventory

Inventory APIs

Classes

Registration
Operations
Consumer
Metrics

Shopify

Shopify APIs
- Generate Shopify Multipass URLget

Invoices

Invoice APIs
Group Invoices
- Create a group invoicepost
- Send a group invoice emailpost
Membership Invoices
Product Invoices
Package Invoices
- Ability to redeem Series Regular Package in APIpost
- Ability to Sell Series Regular Packages in APIpost
Invoice Payments

Queue

Queue APIs

Webhook Events

Webhook Events
Invoice Events
- Invoice Closed
Guest Events
Classes Schedule Events
Classes Booking Events
Guest Membership Events
Appointment Events
- Appointment Started
- Appointment Completed
Appointment Feedback Event
- Feedback Started (Feedback V2)
- Feedback Started (Feedback V1)
Appointment Group Events
- Appointment Group Created
- Appointment Group Status
Employee Events
Guest Package Events

Appointment Feedback Event

This automation notifies your application whenever the following Feedback events occur:

Feedback Started

Check the API documentation for the guest feedback event.