Developer API

Programmatically send review invites via our REST API. Perfect for CRM integrations and automation workflows.

Getting Started

1. •Go to Dashboard → Integrations → Developer API
2. •Click "Generate API Key"
3. •Copy and save your API key securely (you won't see it again)
4. •Find your pageSlug in the URL of your review page:https://your-domain.com/acme-plumbing ← This is your pageSlug

Send Invite Endpoint

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "pageSlug": "acme-plumbing",           // Required: Your review page slug
  "channel": "email",                    // Required: "email" or "sms"
  "contacts": [                          // Required: Array of contacts
    { 
      "name": "John Doe",                // Required
      "email": "john@example.com"        // Required for email channel
      // "phone": "+1234567890"           // Required for sms channel
    }
  ],
  "template": "Hi {name}, review us: {link}"  // Optional: Custom message
}

{
  "success": true,
  "sent": 1,
  "failed": 0,
  "errors": []
}

Code Examples

curl -X POST https://your-domain.com/api/v1/invite \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "pageSlug": "acme-plumbing",
    "channel": "email",
    "contacts": [{"name": "John", "email": "john@example.com"}],
    "template": "Hi {name}, review us: {link}"
  }'

const response = await fetch('/api/v1/invite', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk_live_xxx',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    pageSlug: 'acme-plumbing',
    channel: 'email',
    contacts: [{ name: 'John', email: 'john@example.com' }],
    template: 'Hi {name}, review us: {link}'
  })
});

const data = await response.json();

import requests

response = requests.post(
    'https://your-domain.com/api/v1/invite',
    headers={
        'Authorization': 'Bearer sk_live_xxx',
        'Content-Type': 'application/json'
    },
    json={
        'pageSlug': 'acme-plumbing',
        'channel': 'email',
        'contacts': [{'name': 'John', 'email': 'john@example.com'}],
        'template': 'Hi {name}, review us: {link}'
    }
)

data = response.json()