Authentication Overview

The Vivreal API uses API key authentication. This is the only API you need to integrate with as a developer.

How It Works

Your Website / App
  │
  └── Vivreal API ────── API Key (Authorization header)

1. Get your API key from the Vivreal portal under Group Settings
2. Pass it in the Authorization header on every request
3. The API returns your group's published content

const res = await fetch(
  "https://client.vivreal.io/tenant/collectionObjects?collectionId=abc123",
  { headers: { Authorization: process.env.VIVREAL_API_KEY } }
);
const { data } = await res.json();

API Key Properties

Next Steps

• API Keys — Detailed guide on generating and managing API keys
• API Reference — Full endpoint documentation