API Reference

Complete reference for the StweetHQ REST API, covering authentication, endpoints, request formats, and response schemas.

Overview

The StweetHQ API is a RESTful JSON API that gives you full programmatic access to your testimonials, collections, widgets, and analytics. All API requests require authentication via API key and are rate-limited based on your plan tier.

Authentication

Include your API key in the Authorization header as a Bearer token with every request. API keys can be generated and revoked from the Settings page in your dashboard. Use separate keys for development and production environments to maintain security.

Core Endpoints

The API exposes resources at /v1/testimonials, /v1/collections, /v1/widgets, and /v1/analytics. Each resource supports standard CRUD operations with filtering, pagination, and sorting via query parameters. All responses follow a consistent envelope format with data, meta, and error fields.

Rate Limits and Errors

API requests are rate-limited to 100 requests per minute on the free plan and 1000 per minute on paid plans. When a limit is exceeded, the API returns a 429 status with a Retry-After header. All errors include a machine-readable code field and a human-readable message for debugging.

Next Steps

Explore the official SDKs for a higher-level interface, or check out the webhooks guide to receive real-time notifications about testimonial events.