REST API

API Overview

The SmarterForm REST API allows you to interact with your forms and submissions programmatically. Build custom integrations, automate workflows, or create your own form management tools.

Authentication

All API requests require authentication using an API key. You can generate API keys from your account settings.

1. 1

   Generate an API key

   Go to Settings → API Keys and click Create new key.

2. 2

   Include in requests

   Add your API key to the Authorization header:

   Authorization: Bearer YOUR_API_KEY

Available Endpoints

List all forms

GET /api/v1/forms

Response:
{
  "forms": [
    {
      "id": "form_123",
      "name": "Contact Form",
      "createdAt": "2024-01-15T10:00:00Z",
      "published": true
    }
  ]
}

Get a specific form

GET /api/v1/forms/{formId}

Response:
{
  "id": "form_123",
  "name": "Contact Form",
  "questions": [...],
  "settings": {...}
}

Get form submissions

GET /api/v1/forms/{formId}/submissions

Response:
{
  "submissions": [
    {
      "id": "sub_xyz",
      "submittedAt": "2024-01-15T11:30:00Z",
      "responses": {
        "name": "John Doe",
        "email": "john@example.com"
      }
    }
  ]
}

Rate Limits

API requests are rate-limited to ensure fair usage:

• Pro plan: 1,000 requests per hour
• Rate limit headers are included in all responses
• Exceeding limits returns a 429 status code

Best Practices

• Secure your API keys: Never expose API keys in client-side code
• Handle errors: Implement proper error handling for all API calls
• Use pagination: For large datasets, use pagination parameters
• Cache responses: Cache API responses when appropriate to reduce requests