API Documentation

Integrate SalonIQ into your tools with the REST API or MCP endpoint.

REST API

GET/api/v1/stats

Returns key business intelligence metrics for a salon.

Query Parameters

user_idstring (required) — Your user/salon ID

Response

{ "todayRevenue": 450, "monthRevenue": 12500, "utilizationPct": 72, "noShowRate": 14, "stylistCount": 3 }

POST/api/appointments

Create a new appointment.

Request Body

{ "user_id": "...", "stylist_id": "...", "client_name": "Sarah L", "service": "Color", "price": 120, "scheduled_at": "2025-03-01T10:00:00Z", "status": "scheduled" }

Response

{ "data": { "id": "...", "status": "scheduled", ... } }

MCP Endpoint

Use SalonIQ with Claude, Cursor, and other MCP-compatible AI tools.

Endpoint URL

POST /api/mcp

get_stats— Get utilization, no-show rate, and revenue stats

add_appointment— Create a new appointment

get_stylists— List active stylists for a salon

// Example: initialize
POST /api/mcp
{ "jsonrpc": "2.0", "method": "initialize", "id": 1 }

// Example: get stats
{ "jsonrpc": "2.0", "method": "tools/call", "id": 2, "params": { "name": "get_stats", "arguments": { "user_id": "your-user-id" } } }