...

API Documentation

Welcome to the Five Stars Coach Integration API. This API allows you to automate client onboarding, connect external CRM systems, and streamline your workflow.

💡
Quick Start To get started, you'll need an API key. Contact us at luca@fivestarscoach.it to request your credentials.

Base URL

All API requests should be made to the following base URL:

Production
https://integration.stars.coach/wp-json/v1

Authentication

All API requests require authentication via an API key. Include your key in the request headers.

Required Headers

Headers
x-api-key: YOUR_API_KEY
Content-Type: application/json
⚠️
Keep your API key secure!
Never expose your API key in client-side code or public repositories. Always make API calls from your server.

Create Client

Register a new client in the Five Stars Coach system. This will create the client account, set up their review management, and optionally trigger onboarding emails.

POST /client

Request Body

Parameter Type Status Description
full_name string Required The client's full name
email string Required A valid email address for the client
plan string Required The Plan ID to assign to the client
company_name string Optional The client's business or company name
plan_name string Optional Display name for the plan (e.g., "Professional")
location_address string Optional Business address for the location

Example Request

cURL
curl -X POST "https://integration.stars.coach/wp-json/v1/client" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "full_name": "Mario Rossi",
    "email": "mario@pizzeriadamario.it",
    "plan": "6922d7a48f23393b07dc46e1",
    "company_name": "Pizzeria Da Mario",
    "plan_name": "Professional"
  }'

Responses

201 Created - Client successfully registered
{
  "success": true,
  "message": "Client created successfully",
  "client_id": "6923a1b2c3d4e5f6g7h8i9j0"
}
400 Bad Request - Invalid API Key
{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY"
}
400 Bad Request - Missing Fields
{
  "success": false,
  "error": "Missing required fields: email, plan",
  "code": "MISSING_FIELDS"
}
400 Bad Request - Invalid Email
{
  "success": false,
  "error": "Invalid email format",
  "code": "INVALID_EMAIL"
}

Health Check

Verify that the API is operational and check your connection.

GET /health

Example Request

cURL
curl -X GET "https://integration.stars.coach/wp-json/v1/health"

Response

200 OK - API is operational
{
  "status": "ok",
  "service": "Five Star Coach API",
  "timestamp": "2026-02-25T14:30:00+00:00"
}

Plan IDs

Use the following Plan IDs when creating clients. Contact us if you need a custom plan configuration.

  • Starter - Basic features 6922d7408f23393b07dc46e0
  • Professional - Advanced features + Connexify 6922d7a48f23393b07dc46e1
  • Enterprise - Full suite + Priority support 692319378f23393b07dc470a
📧
Automatic Onboarding Emails Clients assigned to Professional or Enterprise plans will automatically receive a Connexify setup email to connect their social media accounts.

Error Codes

The API uses standard HTTP status codes and returns detailed error information in the response body.

Code Error Code Description
400 INVALID_API_KEY The API key provided is invalid or missing
400 MISSING_FIELDS One or more required fields are missing from the request
400 INVALID_EMAIL The email address provided is not valid
500 SERVER_ERROR An unexpected error occurred on our server

Support

Need help with the API integration? We're here to assist you.

📬
Contact Us
Email: luca@fivestarscoach.it
Response time: Within 24 hours on business days
Video embed code not found.
Seraphinite AcceleratorOptimized by Seraphinite Accelerator
Turns on site high speed to be attractive for people and search engines.