Back to platform Back to platform
Open API · v1

Build on top of
CaptiveWiFi.

Pull guest data, push to your systems, query connection events, and respond to feedback: all through a clean REST API with full documentation.

REST API
JSON responses
Bearer token auth
Full documentation
Webhook support
Rate limiting handled
Capabilities

Pull. Push.
Query. Respond.

Four core capabilities for developers who want to extend CaptiveWiFi into their own platforms and workflows.

GET
Pull
Retrieve guest profiles, connection events, opt-in data, feedback, and venue analytics on demand.
POST
Push
Send data into CaptiveWiFi — sync CRM records, update guest profiles, or trigger marketing events.
GET
Query
Filter and query connection data by venue, date range, device type, opt-in status, and more.
POST
Respond
Post replies to feedback, trigger automated responses, and close the loop on reviews programmatically.
Code Examples

Up and running
in minutes.

Authenticate with a Bearer token. Every response is JSON. Every endpoint is documented.

GET /guests
// Fetch recent opt-in guests for a venue

const response = await fetch(
  'https://dashboard.captivewifi.io/api/v1/guests',
  {
    method: 'GET',
    headers: {
      'Authorization': `Bearer ${API_KEY}`,
      'Content-Type': 'application/json'
    },
    params: {
      venue_id: 'venue_abc123',
      opted_in: true,
      from: '2026-05-01',
      limit: 100
    }
  }
);

const { guests, meta } = await response.json();

// Response
{
  "guests": [
    {
      "id": "g_7f3k2",
      "email": "guest@example.com",
      "first_seen": "2026-05-08T18:34:00Z",
      "visit_count": 3,
      "opted_in": true,
      "venue_id": "venue_abc123"
    }
  ],
  "meta": {
    "total": 284,
    "page": 1
  }
}
POST /feedback/reply
// Post a reply to a piece of feedback

const response = await fetch(
  'https://dashboard.captivewifi.io/api/v1/feedback/reply',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${API_KEY}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      feedback_id: 'fb_9x2m1',
      reply: 'Thank you for your visit.
We really appreciate your feedback
and hope to see you again soon.',
      send_email: true
    })
  }
);

// Response
{
  "success": true,
  "feedback_id": "fb_9x2m1",
  "replied_at": "2026-05-15T09:12:44Z",
  "email_sent": true
}
Endpoints

Everything you need.
Nothing you don't.

A focused set of endpoints covering guest data, venues, connections, feedback, and analytics. Full reference documentation available in the developer portal.

Full API Reference →
GET
/api/v1/guests
List guest profiles with filtering by venue, date, opt-in status
GET
/api/v1/guests/{id}
Retrieve a single guest profile by ID
GET
/api/v1/connections
Query WiFi connection events by venue and date range
GET
/api/v1/venues
List venues and location metadata for your account
GET
/api/v1/feedback
Retrieve feedback submissions with sentiment scores
POST
/api/v1/feedback/reply
Post a reply to a feedback submission
POST
/api/v1/guests/sync
Push guest records from an external CRM into CaptiveWiFi
GET
/api/v1/analytics
Pull venue analytics: opt-in rates, visit frequency, peak times
Use Cases

What developers
build with it.

The API is used by technology partners, integration teams, and in-house developers to extend CaptiveWiFi into their own platforms.

CRM integration
Pull opt-in guest data into Salesforce, HubSpot, or a custom CRM. Keep guest profiles in sync automatically.
Automated feedback replies
Use the feedback endpoint to trigger AI-generated or template replies. Close the loop without manual effort.
Custom dashboards
Pull connection and analytics data into your own BI tool or internal dashboard. Tableau, Looker, Power BI.
POS and loyalty sync
Match WiFi connection events to POS transactions. Enrich loyalty profiles with visit frequency and spend data.
Marketing automation
Trigger Klaviyo, Airship, or Mailchimp flows from WiFi connection events. First visit, return visit, lapsed guest.
Tech partner integration
Building a hospitality platform? White-label or embed CaptiveWiFi data into your product via the API.
Webhooks

Connect to any system.
No developer needed.

CaptiveWiFi fires webhooks for two key events — guest WiFi logins and feedback submissions. Send that data anywhere: your own endpoint, Make.com, Zapier, or any automation platform.

Guest WiFi Login
Fires the moment a guest authenticates. Payload includes name, email, phone, marketing consent, location and timestamp.
Feedback Submission
Fires when a guest submits feedback. Payload includes rating, comments, venue, and guest identity if known.
Don't have a developer? Plug straight into Make.com or Zapier and connect guest data to 1,000+ apps without writing a line of code.
Make.com Zapier or any HTTP endpoint
Webhook payload · guest.login
LIVE
{
  "event": "guest.login",
  "timestamp": "2026-05-16T18:32:00Z",
  "venue": "Aqua Shard · Level 31",
  "guest": {
    "name": "James Carrington",
    "email": "j.carrington@gmail.com",
    "phone": "+447700900123",
    "marketing_consent": true,
    "returning": true,
    "visit_count": 4
  }
}
Developer Access

Ready to build?
Start with the docs.

Full API reference, authentication guide, and code examples available in the developer portal. Or talk to the team if you're planning an integration.

View API Docs Talk to the team

REST API·JSON·Bearer auth·Full docs included