The Playtomic Club API empowers club owners to seamlessly integrate their booking data with external systems, streamlining operations and enhancing the member experience. This comprehensive guide covers everything you need to know about accessing and using our API.
What is the Playtomic Club API?
The Playtomic Club API is a secure, read-only interface that allows clubs to access their booking data programmatically. Whether you operate a single location or manage multiple facilities, the API enables you to:
- Integrate with existing systems like CRMs, marketing tools, loyalty platforms, or facility management software
- Access real-time and historical booking data for the past 3 months
- Automate data synchronization to streamline club operations
-
Enhance member communication through external tools and platforms
📋 Note for Syltek Clubs: You can use the API with the same data visibility as in Manager. While bookings sync from Syltek, please note that not all schedule elements (like classes) may be synchronized.
Who Can Access the API?
API access is available for:
- Single location clubs with Champion or Master subscription plans
- Multi-location clubs where each tenant has Champion or Master subscription
- Chain owners who get unified access to all club data within their organization
Current API Features
Our read-only API provides access to comprehensive booking data, including:
- Booking ID and timestamps (UTC format)
- Court information (ID, name)
- Player details (IDs, email, communication preferences)
- Payment information
- And much more (view complete data specification)
Upcoming Features
We're actively expanding the API with:
- Player data endpoints (using the same authorization)
- Enhanced payment history access
- Detailed event, activity, and clinic data
Contact your account manager to request specific features or express interest in upcoming capabilities.
Getting Started
1. Request Access
- Contact your Playtomic account manager or Customer Care via chat to request API access
- Receive your credentials via a secure link (valid for 3 days, maximum 3 opens)
- Store credentials securely - the temporary link will expire
- Access documentation and begin integration
📄 Complete API Documentation (v1.1)
⚠️ Important: Save your credentials immediately as the access link expires quickly and cannot be regenerated easily.
2. Understanding Authentication
The API uses OAuth 2.0 for secure access:
Your Credentials:
- Client ID & Client Secret: Unique identifiers for your club/system
- Access Token: Temporary credential (typically valid for 1 hour) for API calls
Token Request Example:
POST <https://api.playtomic.io/oauth/token>
Content-Type: application/json
{
"client_id": "your_client_id",
"client_secret": "your_client_secret",
"grant_type": "client_credentials"
}
Making API Calls:
GET <https://api.playtomic.io/v1/bookings> Authorization: Bearer your_access_token
🔒 Security Best Practices:
- Keep your Client Secret confidential
- Never expose credentials in public repositories
- Implement automatic token renewal in your systems
Data Specifications & Limitations
Timezone Handling
- All timestamps are in UTC - ensure your systems convert to local timezone
- Verify your club's timezone settings in Playtomic Manager > Settings > Club Info
Data Availability
- Historical data: Past 90 days
- Future bookings: Available as scheduled
- Maximum request range: 365 days (90 past + 275 future, or 365 future)
Rate Limits
API calls are subject to rate limiting (typically 1 call per minute) to ensure system stability. Check documentation for current limits.
Common Use Cases
Transform your club operations with these popular integrations:
- CRM Synchronization: Import booking data for targeted marketing campaigns
- Analytics & Reporting: Analyze court utilization and player frequency patterns
- Member Communication: Send automated confirmations and reminders via external tools
- Facility Management: Integrate with smart door locks, lighting, or other IoT systems
- Loyalty Programs: Track member activity for rewards and retention programs
Troubleshooting & Support
Getting Help
- Account Manager: Feasibility assessment and access requests
- Technical Support: API troubleshooting and integration assistance
- Documentation: Complete examples, parameters, and endpoint descriptions
Testing Your Integration
While we don't provide a separate testing environment, you can safely test with your actual booking data using limited queries during development.
Frequently Asked Questions (FAQ)
Authentication & Access
Q: How do I get API credentials?
A: Contact your Playtomic account manager or support team. Once approved, you'll receive a secure link (valid 3 days, 3 opens max) containing your Client ID and Client Secret.
Q: What should I do if I get "Unauthorized" errors (401/403)?
A: Common solutions:
- Verify your
Authorization: Bearer tokenheader is included - Check if your access token has expired (refresh if needed)
- Confirm your Client ID and Client Secret are correct
-
Ensure you haven't exceeded rate limits
Q: Can someone else in my organization request new credentials?
A: Yes, but important: New credential requests will revoke the old ones. Share credentials within your organization to avoid disrupting existing integrations.
Data Access & Capabilities
Q: Can I create or modify bookings through the API?
A: No, the current API is read-only. You can retrieve and analyze booking data but cannot create, update, or delete bookings.
Q: How much historical data can I access?
A: You can access booking data from the past 90 days plus all future bookings. Maximum request range is 365 days total.
Q: What timezone are the API timestamps in?
A: All timestamps are in UTC. Your integration must convert these to your local timezone. Verify your club's timezone is correctly set in Playtomic Manager.
Multi-Location & Chain Management
Q: As a chain owner, do I get access to all my clubs' data?
A: Yes! Chain owners receive unified access to booking data across all clubs in their organization. You can filter requests for specific clubs or retrieve data for all locations.
Q: Do all locations need Champion/Master subscriptions?
A: Yes, for multi-location access, each tenant must have a Champion or Master subscription plan.
Technical Implementation
Q: How often can I call the API?
A: Rate limits are in place (typically 1 call per minute) to ensure system stability. Check the documentation for current limits and plan your integration accordingly.
Q: Can I test the API before going live?
A: While there's no separate testing environment, you can safely test with your actual booking data using limited queries during development.
Q: Will more features be added to the API?
A: Yes! We're actively developing:
- Player data endpoints (same authorization)
- Enhanced payment history
- Detailed event and clinic data
Contact your account manager to request specific features.
Support & Troubleshooting
Q: What information should I provide when requesting support?
A: Include:
- Full error message
- Specific endpoint you were calling
- Your Club ID
-
Steps you've already tried
Q: Who should I contact for different types of issues?
A:
- Access requests: Account manager or Customer Care via chat to request API access
- Technical integration: Technical support team
- Feature requests: Account manager
- Billing/subscription: Account manager
Need additional assistance? Contact your Playtomic account manager or our Customer Care team for personalized help with your API integration.
Comments
Please sign in to leave a comment.