Developers

API reference

Integrate People Loop with your stack using our REST API. The machine-readable contract is published as OpenAPI 3 JSON.

Base URL

All API routes are served under:

https://peopleloop.io/api

Replace with your preview domain when testing pull-request deployments (for example https://<project>.vercel.app/api).

Authentication

Most endpoints expect an authenticated user session backed by Supabase Auth. In practice you obtain a session after login (browser cookie or client session) and issue requests from your backend or a trusted environment using the same security model as the dashboard.

Public widget and configuration endpoints are documented separately in the OpenAPI spec and are designed for embed and public-site use cases (not for exposing private org data).

Do not embed service-role or secret keys in client-side code. Route privileged operations through your server.

OpenAPI specification

Download the full schema as JSON (suitable for Postman, Insomnia, code generators, and CI):

GET https://peopleloop.io/api/docs

Response: application/json OpenAPI 3 document describing paths, request bodies, and response shapes.

Rate limits and errors

Production traffic is rate limited to protect the platform. If you receive HTTP 429, back off with exponential retry and reduce burst volume. Error bodies may include a request id — include it when contacting support@peopleloop.io.

Changelog

Breaking changes will be communicated ahead of time when possible. For integration planning, pin your client to a tested API version period and monitor deploy notes from your account team.