API v1Developer Documentation

Build on stigmi

55+ REST endpoints, 58+ MCP tools, and OAuth2 authentication. Automate form creation, collect responses programmatically, and integrate with your own apps.

Quick Start

1

Get an API Token

Sign up for a Pro+ account, then go to API Tokens in your dashboard to create a Bearer token.

2

Make Your First Request

Use your token as a Bearer header in requests to https://stigmi.app/api/v1/forms.

3

Explore MCP Tools

Use the MCP server with Claude Desktop or any MCP-compatible AI client for natural language form management.

Example: List your forms

curl -X GET https://stigmi.app/api/v1/forms \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

REST API v1

Base URL: https://stigmi.app/api/v1

Requires Pro+ plan

Authentication: All requests require Authorization: Bearer YOUR_TOKEN header. Create tokens in Dashboard → API Tokens.

GET/api/v1/formsList all your forms with pagination
POST/api/v1/formsCreate a new form
GET/api/v1/forms/:idGet form details with questions and endings
PATCH/api/v1/forms/:idUpdate form title, settings, or status
DELETE/api/v1/forms/:idDelete a form and all its responses
GET/api/v1/forms/:id/questionsList all questions in a form
PUT/api/v1/forms/:id/questionsReplace all questions (bulk update)
GET/api/v1/forms/:id/responsesList responses with pagination and filters
GET/api/v1/forms/:id/responses/exportExport responses as CSV (PRO+)
POST/api/v1/forms/:id/submitSubmit a response to a formNo auth

Response Format

Success (200)

{
  "forms": [...],
  "total": 42,
  "page": 1,
  "limit": 20
}

Error (4xx/5xx)

{
  "error": "Unauthorized",
  "message": "Invalid or expired token"
}

MCP Server

58+ tools across 16 categories. Connect Claude Desktop, Cursor, or any MCP-compatible AI client.

HTTP

Streamable HTTP (Production)

Connect to the hosted MCP server at https://stigmi.app/mcp. Uses OAuth2 or Bearer token authentication.

# Claude Desktop config
{
  "mcpServers": {
    "stigmi": {
      "url": "https://stigmi.app/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}
stdio

stdio (Local / CLI)

Run the MCP server locally via Node.js. Interactive OAuth2 login with PKCE. Tokens persisted at ~/.stigmi/tokens.json.

# Claude Desktop config
{
  "mcpServers": {
    "stigmi": {
      "command": "node",
      "args": ["mcp/dist/server.js"],
      "env": {
        "STIGMI_BASE_URL": "https://stigmi.app"
      }
    }
  }
}

Tool Categories (58+ tools)

Forms8 tools

Create, list, update, delete, duplicate, and manage form status

Questions4 tools

Add, update, delete, and reorder questions in a form

Responses5 tools

List, filter, export, and annotate responses

Analytics3 tools

Completion rates, drop-off analysis, NPS scores

Endings4 tools

Manage custom thank-you screens and redirects

Logic Rules4 tools

Create conditional jump logic and form branching

A/B Testing4 tools

Create and manage A/B test variants (Pro+)

Public Forms3 tools

Read public form data and submit responses

Annotations3 tools

Add notes and tags to responses (Pro+)

Tickets4 tools

Create and manage support tickets

API Tokens3 tools

Manage API tokens for programmatic access (Pro+)

Payments2 tools

Create Razorpay payment orders and verify payments

Admin5 tools

User management and platform stats (admin only)

Templates3 tools

Browse and instantiate form templates

Health1 tools

Check API health and connectivity

Tokens (OAuth)2 tools

OAuth2 token introspection and revocation

OAuth2 Integration

Standard OAuth2 Authorization Code flow with PKCE. Build integrations that act on behalf of stigmi users.

Endpoints

AuthorizationPOST /api/oauth/authorize
Token ExchangePOST /api/oauth/token
Token RevocationPOST /api/oauth/revoke
User InfoGET /api/oauth/userinfo
Server MetadataGET /.well-known/oauth-authorization-server

OAuth2 Flow

  1. 1Register your OAuth client via POST /api/oauth/clients
  2. 2Redirect user to /oauth/consent with client_id, redirect_uri, scope, and PKCE code_challenge
  3. 3User approves — you receive an authorization code
  4. 4Exchange code for access token via POST /api/oauth/token with code_verifier
  5. 5Use access token as Bearer header in all API requests

Webhooks

Get notified in real time when new responses are submitted to your forms.

Setup

Set a Webhook URL in your form's settings. stigmi will POST a JSON payload to your endpoint for every new submission.

HMAC-SHA256 signature in X-Stigmi-Signature header
Retries up to 3 times on failure (exponential backoff)
Logs stored per form for debugging

Webhook Payload

{
  "event": "response.created",
  "formId": "clx...",
  "responseId": "clx...",
  "submittedAt": "2026-03-20T10:00:00Z",
  "answers": [
    {
      "questionId": "clx...",
      "questionLabel": "Your name",
      "value": "Alice"
    }
  ]
}

Rate Limits & Plans

ResourceLimitNotes
API requests1,000 / hourPer token
Form submissionsUnlimitedAll plans
Registration endpoint5 / minutePer IP
Webhook retries3 attemptsExponential backoff
Response exportUnlimited rowsPRO+ plan

Ready to build?

Get your API token and start integrating in minutes. Pro+ plan required for REST API and MCP access.