API reference
ScatterSpoke has two programmatic entry points: workspace API keys for direct requests, and the MCP server for AI clients. This page says what each one is and where it is documented; it is not itself an endpoint reference.
Workspace API keys
Section titled “Workspace API keys”API keys authenticate requests to the ScatterSpoke API as a bearer token. Keys belong to a workspace, carry an owner, and respect role-based permissions. A key’s secret is shown once, when it is created.
Keys are managed under Settings → API, where each key lists its prefix, scopes, owner, creation date, last use, and expiry, and can be revoked.
Every key opts in to an explicit set of scopes; requests outside a key’s scopes are rejected.
| Scope | Grants |
|---|---|
read:surveys | List and read surveys, questions, sections, and templates |
write:surveys | Create, update, and close surveys |
read:responses | Read individual survey responses and their conversation threads |
read:themes | Read clustered themes, sentiment, and surfaced signals |
read:members | List workspace users, teams, and groups |
API key access is a Business and Enterprise capability. See API keys for creating and revoking them, and Plans and tiers for what else each tier includes.
MCP server
Section titled “MCP server”The MCP server exposes workspace feedback to MCP-capable AI clients — Claude Code, Claude Desktop, and Codex among them. It is reached over HTTP and authenticated with OAuth: the client opens a browser sign-in on first use, so there is no key to mint or paste.
MCP connectivity is available on every plan tier; the insight tools it exposes are entitled separately.
Developer reference
Section titled “Developer reference”A generated TypeScript reference is produced from the platform’s source with TypeDoc and covers ScatterSpoke’s internal packages — domain, agents, signals, realtime, temporal, and logging. It documents platform internals rather than the workspace API surface described above, and it is not currently published at a public URL.