Public REST API
Generate API keys and access PROOF data programmatically.
API Overview
The PROOF Public REST API v1 lets you access your campaign, contract, and analytics data programmatically. API keys are managed from the Integrations page under Public API.
Available Endpoints
- GET /v1/campaigns — List all your campaigns with filtering and pagination
- GET /v1/contracts — List all contracts across campaigns
- GET /v1/analytics — Aggregate analytics data (views, engagements, spend efficiency)
Authentication
All API requests must include your API key in the X-API-Key header. Keys are hashed with SHA-256 and stored securely. You can generate, revoke, and manage keys from the Integrations page.
Each key has scoped permissions — you can control which endpoints and data the key can access (7 permission types available).
Treat API keys like passwords. Never expose them in client-side code, public repositories, or shared documents. Revoke and regenerate if a key is compromised.
Was this article helpful?