Pool Service
API
Complete programmatic access to your pool service business data. Integrate UpBuoy with your existing systems and build custom workflows.
API Documentation
Quick Start
Get started with the UpBuoy API in minutes. Simple authentication and RESTful endpoints.
Base URL
https://app.upbuoy.com/api/v1Authentication
Authorization: Bearer YOUR_API_KEYExample Request
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://app.upbuoy.com/api/v1/data?include=all"Data Integration
Complete Business
Data Access
Access all your pool service business data through a single, unified API. Perfect for integrations, custom dashboards, and automated workflows.
Customer Management
Full customer profiles, contact information, and service history
Service Operations
Service stops, work orders, chemical readings, and equipment data
Business Analytics
Revenue metrics, performance data, and operational insights
Available Endpoints
RESTful API endpoints for accessing and managing your pool service data.
Data Access (GET)
/api/v1/dataGet all your business data in one comprehensive endpoint
/api/v1/data?include=allGet customers, pools, work orders, service stops, users, and metrics
/api/v1/data?customers=trueGet only customer data
/api/v1/data?pools=trueGet only pool data
/api/v1/data?work_orders=trueGet only work order data
/api/v1/data?service_stops=trueGet only service stop data
/api/v1/data?users=trueGet only user/team member data
/api/v1/data?metrics=trueGet only business metrics
Data Creation (POST)
/api/v1/dataCreate new customer. Send: {"type": "customer", "data": {...}}
/api/v1/dataCreate new pool. Send: {"type": "pool", "data": {...}}
/api/v1/dataCreate new work order. Send: {"type": "work_order", "data": {...}}
/api/v1/dataCreate new service stop. Send: {"type": "service_stop", "data": {...}}
/api/v1/dataCreate new team member. Send: {"type": "user", "data": {...}}
Example Requests
Common API usage patterns and real-world examples.
Get All Customer Data
curl -H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
"https://app.upbuoy.com/api/v1/data?customers=true&limit=50"Returns up to 50 customers with their contact info, status, and billing details.
Create a New Customer
curl -X POST \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "customer",
"data": {
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"phone": "(555) 123-4567",
"address": "123 Main St, Anytown, CA 90210",
"status": "Active"
}
}' \
"https://app.upbuoy.com/api/v1/data"Creates a new customer with the provided information. Required fields: first_name, last_name.
Example Response
{
"customers": [
{
"id": 123,
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"phone": "(555) 123-4567",
"address": "123 Main St",
"status": "Active",
"billing_cycle": "Monthly",
"created_at": "2024-01-15T10:30:00Z"
}
],
"metadata": {
"organization_id": "456",
"timestamp": "2024-03-15T14:30:00Z",
"api_version": "v1"
}
}Common Use Cases
Real-world integration scenarios for pool service businesses.
Custom Dashboards
Build executive dashboards with real-time business metrics, revenue tracking, and operational insights tailored to your specific needs.
CRM Integration
Sync customer data with your existing CRM system to maintain unified customer records and streamline sales processes.
Automated Reporting
Generate custom reports for clients, regulatory compliance, or internal analysis with automated data extraction and formatting.
Workflow Automation
Create automated workflows that trigger based on service events, customer status changes, or business milestones.
Security & Limits
Enterprise-grade security with reasonable usage limits for production applications.
Security
Usage Limits
Start building with
UpBuoy API
Get your API key and start integrating in minutes. Complete access to your pool service business data with comprehensive documentation.