API Introduction

The Prooflio API is a RESTful interface that lets you access your organization’s review data and embed social proof widgets programmatically. You can retrieve reviews, fetch aggregate statistics, and generate embeddable widgets and SEO schemas.

Base URL

All API requests are made to:


https://app.prooflio.io/api/v1

The API is served exclusively over HTTPS. Any request made over plain HTTP will be rejected.

Authentication

Authenticate every request by including your API key in the Authorization header:


Authorization: Bearer YOUR_API_KEY

API keys are created in Settings > API Keys within your organization dashboard. See the Authentication page for full details.

API access requires a Growth plan or higher. Free and Starter plans do not include API access.

Request Format

The API accepts standard query parameters for filtering and pagination on GET endpoints. No request body is required for any of the current endpoints.


curl "https://app.prooflio.io/api/v1/reviews?limit=10&platform=GOOGLE" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Format

All responses return JSON. The structure depends on the type of resource returned.

List with Pagination


{
  "data": [
    {
      "id": "clx...",
      "platform": "GOOGLE",
      "authorName": "Jane D.",
      "rating": 5,
      "content": "Excellent service!"
    }
  ],
  "pagination": {
    "total": 142,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}

Single Resource


{
  "data": {
    "totalReviews": 142,
    "averageRating": 4.37,
    "averageSentiment": 0.71
  }
}

Error


{
  "error": "unauthorized",
  "message": "Invalid or missing API key.",
  "details": []
}

See the Error Handling page for the full list of error codes.

Available Endpoints

The Prooflio API provides four endpoints:

Endpoint	Description
`GET /api/v1/reviews`	Retrieve a paginated list of reviews with filtering
`GET /api/v1/reviews/stats`	Get aggregate review statistics and breakdowns
`GET /api/v1/widgets/{id}/embed`	Get a JavaScript snippet to embed a review widget
`GET /api/v1/widgets/{id}/schema`	Get JSON-LD structured data for SEO rich snippets

Quick-Start Example


# Fetch your latest reviews
curl "https://app.prooflio.io/api/v1/reviews?limit=5" \
  -H "Authorization: Bearer YOUR_API_KEY"
 
# Get aggregate statistics
curl "https://app.prooflio.io/api/v1/reviews/stats" \
  -H "Authorization: Bearer YOUR_API_KEY"


// JavaScript example using fetch
const response = await fetch('https://app.prooflio.io/api/v1/reviews?limit=5', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
  },
});
 
const { data, pagination } = await response.json();
console.log(`Found ${pagination.total} reviews`);
data.forEach(review => {
  console.log(`${review.authorName}: ${review.rating}★ — ${review.content}`);
});

What’s Next

Topic	Description
Authentication	API key creation, plan requirements, and security best practices
Rate Limits	Request quotas per plan and how to handle throttling
Error Handling	Error response format and status code reference
Endpoints	Start exploring the available endpoints