DEVELOPER DOCS

REST API Reference

26 endpoints across 6 resource groups. Full programmatic access to guest profiles, analytics, campaigns, locations, devices, and sub-user management.

Get API Key

BASE URL

https://www.mywifi.io/api

AUTH HEADER

identifier: YOUR_API_KEY

FORMAT

JSON (application/json)

AUTHENTICATION

API Key Setup

All requests require your API key passed via the `identifier` header. Generate keys from Settings > API in your reseller dashboard.

Authentication Example
curl https://www.mywifi.io/api/get-social-logins \
  -H "identifier: YOUR_API_KEY" \
  -H "Content-Type: application/json"

RATE LIMITS

Starter1,000 req / hr
Pro5,000 req / hr
Agency10,000 req / hr
MSP / EnterpriseUnlimited

ANALYTICS

7 endpoints

Analytics

Aggregate guest WiFi analytics — auth method breakdowns, demographics, visits, sessions, bandwidth, and device data across your locations.

CAMPAIGNS

4 endpoints

Campaigns

Create, manage, and monitor email and SMS marketing campaigns targeted to guest segments.

DEVICES

4 endpoints

Devices

Manage access points and network devices across your locations. Add, configure, and monitor hardware.

GUESTS

2 endpoints

Guests

Access guest profiles captured via WiFi login — social data, contact info, visit history, and engagement scores.

LOCATIONS

6 endpoints

Locations

Manage venue locations, assign campaigns and devices, and control portal configurations for each site.

SUBUSERS

3 endpoints

SubUsers

Manage sub-user accounts for your clients. Create restricted access accounts, generate SSO tokens, and control permissions per location.

V2 PREVIEW

ROADMAP

Next-gen API Preview

The V2 API is under active development. These endpoints will follow modern RESTful conventions with cursor-based pagination, field selection, and WebSocket streaming. Sign up for early access when available.

COMING SOON
GET
/v2/guests

List guests (paginated, filterable)

RESTful guest list with cursor-based pagination, field selection, and advanced segment filtering. Returns enriched profiles with engagement scores.

COMING SOON
POST
/v2/campaigns

Create campaign with templates

Create campaigns using pre-built templates. Supports A/B testing, dynamic personalization tokens, and automated send-time optimization.

COMING SOON
GET
/v2/analytics/traffic

Real-time traffic analytics

Streaming traffic analytics with WebSocket support. Sub-minute granularity, zone-level heatmaps, and predictive occupancy forecasting.

COMING SOON
GET
/v2/analytics/demographics

Guest demographics dashboard

Unified demographics endpoint combining age, gender, device, and behavioral data into a single queryable resource with comparison periods.

COMING SOON
POST
/v2/webhooks

Manage webhook subscriptions

Programmatically create, update, and test webhook subscriptions. Includes payload signing, retry configuration, and delivery logs.

Want early access to the V2 API?

Request Beta Access

Ready to start building?

Create your free reseller account to generate API keys. All plans include API access — MSP and Enterprise plans get unlimited rate limits.

Get API KeyTalk to Sales