Introduction

Welcome to the Unified Fitness Platform (UFP) API! This powerful, RESTful API is designed for our partners and developers to integrate their applications and services with the UFP ecosystem. Whether you're building custom dashboards, automating workflows, or extending the platform's capabilities, this API provides the tools you need to succeed.

What Can You Do with the API?

The UFP API offers a comprehensive suite of endpoints to manage all aspects of your fitness business operations. Key functionalities include:

Client Management: Create, retrieve, update, and manage the complete lifecycle of your clients, from prospects and trial members to active and former clients.

Scheduling & Booking: Manage individual appointments and group classes, including creating schedules, booking clients, and handling recurring events.

Billing & Subscriptions: Handle all financial aspects, including creating and managing subscription plans, processing invoices, tracking payments, and issuing refunds.

Staff & Access Control: Manage staff profiles, permissions, and access to facilities through integrations with access control systems.

Communication: Engage with your members by sending emails, SMS, and WhatsApp messages, either individually or in bulk using templates.

Analytics & Reporting: Access powerful reporting and analytics tools to gain insights into sales, payments, and client engagement.

Configuration: Customize and configure various platform settings, including tax rules, service categories, and payment gateways.

API Fundamentals

Our API is built on standard REST principles to ensure predictability and ease of use:

JSON Format: All API requests and responses, including errors, are formatted in JSON.

Standard HTTP Methods: We use standard HTTP verbs (GET, POST, PUT, PATCH, DELETE) for all operations.

Predictable URLs: Endpoints are structured logically around resources (e.g., /tenants/{tenant_id}/clients/{client_id}).

Authentication: The API uses JWT Bearer tokens for authentication. All requests must include an Authorization header with a valid token. You'll learn how to obtain one in our Quickstart guide.

Base URLs

All API endpoints are served over HTTPS. Use the appropriate base URL based on your environment:

Production: https://api.unifiedfitnessplatform.ai

Staging: https://api.staging.ufp.ai

Append endpoint paths to the base URL to make requests, e.g.:

Getting Started

Ready to dive in? Head over to our Quickstart Guide to learn how to authenticate and make your first API call in minutes. For detailed information on every endpoint, browse the comprehensive API Docs section.

What Can You Do with the API?#

API Fundamentals#

Base URLs#

Getting Started#

What Can You Do with the API?

API Fundamentals

Base URLs

Getting Started