v1 · REST

API Reference

Create campaigns, read reports, and stream survey responses straight from your stack.

Authentication

Generate a key at Settings → API keys. Pass it as a bearer token on every request. Keys carry read / write / admin scopes and can be revoked instantly.

Authorization: Bearer mm_live_xxxxxxxxxxxx

Base URL

https://softstackresearch.com/api/v1

Endpoints

GET/me

Returns the workspace and scope for the current API key.

GET/campaigns

List campaigns. Optional query params: status, limit (max 100).

POST/campaigns

Create a campaign. Requires write scope.

{
  "name": "Premium ghee - US launch",
  "type": "market_entry",
  "depth": "standard",
  "objective": "Identify top 3 US states to enter…",
  "target_markets": ["United States"],
  "known_competitors": ["4th & Heart"],
  "include_survey": true
}

GET/campaigns/{id}

Get one campaign with its report (if completed).

GET/surveys

List surveys in the workspace.

GET/surveys/{id}/responses

List responses (up to 500 per call).

POST/surveys/{id}/responses

Submit a response, useful for piping CRM contacts via Zapier.

Rate limits

1,000 requests/min per API key. Higher limits on Pro and Enterprise.

Errors

{ "error": "unauthorized" }          // 401
{ "error": "insufficient scope" }     // 403
{ "error": "insufficient credits" }   // 402
{ "error": "not found" }              // 404

Prefer no code?

Our native Zapier app has 3 triggers and 2 actions that connect Softstack Research to 6,000+ apps.

Open Zapier docs →