REST API

The REST API gives your backend direct access to your Simple Commenter account: provision team members and clients, read and update feedback, and mint client login tokens. It is the server-to-server counterpart to the JS API, which runs in the browser.

Authentication

Every request carries an integration token in the X-Integration-Token header:

curl -H "X-Integration-Token: YOUR_TOKEN" \
  "https://www.simplecommenter.com/api/external/domains"

Generate a token under Project settings, Developers (REST API section) or on the AI Agent (MCP) page: it is the same account-wide token, usable for both. Tokens carry scoped actions (read, write, settings); tokens generated from the dashboard have all three.

Treat the token like a password: it grants access to your whole account. Store it in an environment variable or secrets manager, never in client-side code.

Base URL

https://www.simplecommenter.com/api/external

All endpoints accept and return JSON unless noted. Errors come back as { "error": "message" } with a matching HTTP status.

Endpoints

| Area | Endpoint | Documented | | --- | --- | --- | | Members | /members | Members & Clients | | Clients | /clients | Members & Clients | | Client login tokens | /client-token | Members & Clients | | Projects | /domains, /domains/{domainId}/settings | Reference on request | | Comments | /comments, /comments/{commentId}, /comments/reply, /comments/update, /comments/create | Used by the AI Agent (MCP) | | Account | /account | Reference on request |

Addressing projects: endpoints that take a domainId accept the project's public key (sc_...), its project ID, or the domain name.

Rate limits

Requests count against your plan's API allowance (the same pool the AI Agent uses). When you exceed it, requests return 429 until the window resets.

When to use which API

  • REST API: your server manages the account. Sync your user base as clients, add a member when someone joins your team, pull feedback into your own tooling.
  • JS API: the browser logs a visitor in and controls the widget. For most SaaS setups the JS API alone is enough, because a verified identify creates the client automatically on first sight.

Was this page helpful?