API Reference
The Vivreal API lets you fetch your published content, create Stripe checkout sessions, and send contact emails — everything you need to power your website.
Quick Start
curl "https://client.vivreal.io/tenant/siteDetails?siteId=YOUR_SITE_ID" \
-H "Authorization: YOUR_API_KEY"
Base URL: https://client.vivreal.io
Auth: API key in the Authorization header. Get yours from Group Settings in the Vivreal portal.
What You Can Do
| Endpoint | Description |
|---|---|
GET /tenant/siteDetails | Fetch your site's theme, logo, business info, and page config |
GET /tenant/collectionObjects | Fetch published items from any collection (blog posts, events, etc.) |
GET /tenant/integrationObjects | Fetch products synced from Stripe |
GET /tenant/preview | Fetch draft content via a preview token |
POST /tenant/createCheckoutSession | Create a Stripe checkout session for purchases |
POST /tenant/definedCollectionObject | Submit user-generated content (reviews, signups) |
POST /tenant/sendContactEmail | Send a contact form submission to the site owner |
POST /tenant/sendOrderPlacedEmail | Send an order confirmation email to a customer |
Server-side only
Call the API from your server or serverless functions (e.g., Next.js server components). Never expose your API key in client-side JavaScript.
Response Format
Every response uses a standard envelope:
{
"success": true,
"data": { ... },
"error": null
}
Next Steps
- Quickstart — Make your first API call in minutes
- Authentication — How to get and use your API key
- Endpoints — Full reference for every endpoint
- Error Codes — Common errors and how to fix them