API Documentation

Complete API reference for CloudFran Agents integration

🏠 Dashboard 💰 API Pricing 🔑 Webhooks

🔌 CloudFran GBP API Documentation

RESTful API for integrating Google Business Profile management into your applications

🔑 Authentication

All API requests require an API key in the header:

X-API-Key: your_api_key_here

Get your API key: Settings → API Keys → Generate New Key

📍 Locations

GET /api/v1/gbp/locations

Get all locations for a tenant

Query Parameters:

tenantId (required) - Your tenant ID

Example Response:

{
  "success": true,
  "count": 3,
  "locations": [
    {
      "id": "loc-123",
      "name": "Mario's Italian - Downtown",
      "address": "123 Main St",
      "city": "Atlanta",
      "state": "GA",
      "rating": 4.7,
      "reviewCount": 234,
      "phone": "(404) 555-0101"
    }
  ]
}

💬 Reviews

GET /api/v1/gbp/reviews

Get reviews for a specific location

Query Parameters:

locationId (required) - Location ID

POST /api/v1/gbp/reviews/{reviewId}/respond

Respond to a review

Request Body:

{
  "responseText": "Thank you for your review!"
}

📊 Analytics

GET /api/v1/gbp/analytics/summary

Get analytics summary

Query Parameters:

tenantId (required) - Your tenant ID
period (optional) - day, week, month (default: week)

💰 Rate Limits & Pricing

Rate Limits: 1000 requests/hour per API key

Pricing: Free for Enterprise plan subscribers