Getting Started with the WellnessLiving API

What Is the WellnessLiving API?

Imagine having a universal translator that enables different software systems to communicate seamlessly. The WellnessLiving API serves this purpose by allowing your business management platform to interact directly with other applications, facilitating efficient data exchange and automation.

An API (Application Programming Interface) is a set of rules and protocols that enable different software applications to communicate with each other. With the WellnessLiving API, you can programmatically access and manage various aspects of your business data, such as client information, appointments, classes, and more.

In this context, an endpoint functions as a specific address or location where your system can access particular data or services offered by WellnessLiving. Think of each endpoint as a unique mailbox in a vast postal system; by sending a request to a specific mailbox (endpoint), you receive the exact information or service you need. For example, there might be distinct endpoints for retrieving client details, booking appointments, or processing payments. By interacting with these endpoints, your system can perform various tasks and retrieve data as needed.

How Can the API Benefit My Business?

The WellnessLiving API empowers your business to enhance functionality, streamline operations, and create custom solutions tailored to your specific needs. Here's how:

1. Integrate with Third-Party Applications

  • Customer Relationship Management (CRM) Systems: Automatically update client records in platforms like Salesforce or HubSpot when changes occur in WellnessLiving.

  • Email Marketing Tools: Sync client data with services like Mailchimp to send personalized marketing campaigns.

  • Accounting Software: Transfer financial data to QuickBooks or Xero for accurate and up-to-date bookkeeping.

2. Automate Routine Tasks

  • Scheduling: Automatically adjust staff schedules in response to client bookings or cancellations.

  • Notifications: Send custom alerts to clients or staff through SMS or email based on specific triggers.

  • Data Entry: Eliminate manual data entry by automating the transfer of information between systems.

3. Develop Custom Applications

  • Mobile Apps: Create personalized mobile applications that provide clients with a unique booking experience.

  • Dashboards: Build custom dashboards that display real-time metrics and analytics pertinent to your business.

  • Reporting Tools: Design specialized reporting tools that analyze data according to your specific criteria.

Available API Endpoints

The WellnessLiving API offers a wide range of endpoints, each corresponding to different facets of your business operations. Here are some key categories:

Endpoint Category

Description

Examples

Client Management

Manage client profiles and information.

Add new clients, update contact details.

Appointment Scheduling

Handle booking and management of appointments.

Schedule, reschedule, or cancel appointments.

Class Management

Organize and oversee classes and events.

Create new classes, update schedules.

Staff Management

Administer staff-related data.

Add staff members, set availability.

Sales and Purchases

Track sales transactions and inventory.

Record purchases, manage product listings.

For a comprehensive list of endpoints and their functionalities, refer to our Developer Portal.

Getting API Access

Getting access to the WellnessLiving API is a two-step process. First, you get free staging access to build and test your integration. Then, when you're ready to go live, you request production credentials.

Step 1: Submit your request

Go to the WellnessLiving Developer Portal and fill out the API access request form. You'll be asked to provide:

  • Your name, role, and email

  • Your business name and Business ID (BID)

  • What you plan to use the API for

  • Agreement to the API and SDK Terms of Use

After you submit the form, you'll see a confirmation with your reference number. Save this number to use if you need to follow up on your request.

Step 2: Verification

Our integrations team reviews every request within 1 business day. If you're not the Business Owner of record, we'll ask your Business Owner to email us confirming that API access can be shared with you. This step protects your business by making sure your owner knows who has API access.

Step 3: Get your staging credentials

Once your request is verified, we'll email you a Postman collection with your staging environment credentials, delivered through a secure one-time-view link. Staging access is free and lets you build and test your integration with no cost commitment.

Step 4: Go live with production access

When your integration is ready for real customers and real data, email integrations@wellnessliving.com to request production credentials. We'll coordinate with our billing team to enable your API subscription, then send you your production credentials.

Timing to expect

  • First response after form submission: 1 business day

  • Staging credentials delivered: 1–3 business days (depending on verification)

  • Production credentials after upgrade request: 1–2 business days
    ​

Trial customers

API access is available to active WellnessLiving customers only. If you are on a trial, you'll be able to request API access after you activate your subscription.

Webhooks: Real-Time Event Notifications

In addition to the API, WellnessLiving offers webhooks—automated messages sent to your system when specific events occur, such as a new booking or a client update. Webhooks provide real-time data, enabling your applications to respond immediately to changes.

Support and Resources

We're here to assist you at every step:

Did this answer your question?