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.
Base URL
All API requests should be made to the following base URL:
Authentication
All API requests require authentication via an API key. Include your key in the request headers.
Required Headers
x-api-key: YOUR_API_KEY Content-Type: application/json
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.
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 -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
{
"success": true,
"message": "Client created successfully",
"client_id": "6923a1b2c3d4e5f6g7h8i9j0"
} {
"success": false,
"error": "Invalid API key",
"code": "INVALID_API_KEY"
} {
"success": false,
"error": "Missing required fields: email, plan",
"code": "MISSING_FIELDS"
} {
"success": false,
"error": "Invalid email format",
"code": "INVALID_EMAIL"
} Health Check
Verify that the API is operational and check your connection.
Example Request
curl -X GET "https://integration.stars.coach/wp-json/v1/health"
Response
{
"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
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.