API Documentation
Integrate your lifestyle business and events with the Swingular platform
Authentication
Secure API access with OAuth 2.0 and API keys
Endpoints
Comprehensive REST API for events, profiles, and more
Documentation
Detailed guides, examples, and SDK references
API Overview
Getting Started
1. Register as a Partner
Before you can access the API, you need to register as a Swingular partner. This is free and gives you access to our basic API tier.
2. Generate API Keys
Once registered, you can generate API keys from your partner dashboard. These keys are used to authenticate your API requests.
3. Make API Requests
Use your API keys to make requests to our endpoints. All requests should be made over HTTPS and include your API key in the header.
Authentication
API Key Authentication
Include your API key in the Authorization header of your requests:
Authorization: Bearer YOUR_API_KEY
OAuth 2.0
For applications that need to access user data, use OAuth 2.0:
// Step 1: Redirect to authorization URL https://api.swingular.com/oauth/authorize? client_id=YOUR_CLIENT_ID& redirect_uri=YOUR_REDIRECT_URI& response_type=code& scope=events.read,events.write
Rate Limits
Basic Plan
- • 1,000 requests per day
- • 60 requests per minute
- • Cached responses for high-volume endpoints
Premium Plan
- • 10,000 requests per day
- • 300 requests per minute
- • Priority access during high traffic
- • Dedicated support for API integration
API Endpoints
/events
Create, read, update, and delete events. Filter by date, location, and type.
/eventsList all events with pagination and filtering
/eventsCreate a new event
/events/{id}Get a specific event by ID
/events/{id}Update an existing event
/business
Manage your business profile, hours, amenities, and photos.
/businessGet your business profile
/businessUpdate your business profile
/business/photosUpload business photos
/business/reviewsGet reviews for your business
/analytics
Access analytics data for your business and events.
/analytics/eventsGet analytics for your events
/analytics/businessGet analytics for your business profile
/analytics/demographicsGet demographic data for your visitors
/analytics/reportsGenerate custom reports
Ready to Integrate?
Get started with our API today and connect your lifestyle business with millions of potential customers.