REST API
Client API Reference
8 REST endpoints for delivering content to your frontend — collections, products, site config, media, previews, and more.
Content Endpoints
Fetch published content from your collections and integrations.
- GET /siteDetails — theme, logo, business info, page config
- GET /collectionObjects — published items (blog posts, events, etc.)
- GET /integrationObjects — Stripe products synced to your group
- GET /preview — draft content via preview token
Commerce & Contact Endpoints
Handle checkout flows, contact forms, and order confirmations.
- POST /createCheckoutSession — create Stripe checkout session
- POST /definedCollectionObject — user-generated content (reviews, signups)
- POST /sendContactEmail — contact form submission to group owner
- POST /sendOrderPlacedEmail — order confirmation email
Authentication
All requests require an API key in the Authorization header. Keys are generated per group in the portal.
- Header: Authorization: <your-api-key>
- Keys validated by Lambda authorizer (not Cognito)
- Context injected: database, bucketName, groupID, tier
- 1-second TTL — essentially no caching of auth results
Response Format
All endpoints return a standard envelope for consistent error handling.
- Success: { success: true, data: { ... } }
- Error: { success: false, error: "message" }
- Published content filtered by publishDate and archived status
- Media returned as signed CloudFront CDN URLs
Full API Docs in One Place
Detailed request/response examples, error codes, and quickstart guide available at vivreal.io/docs.