ProForms API Documentation

Everything you need to create, manage, and embed forms programmatically.

📝

Forms

Create and manage forms with fields, themes, and conditions

📊

Submissions

Read, export, and manage form submissions

🌐

Sites

Organize forms by website or client

👥

Team

Invite members and manage permissions

Base URL

All API requests are made to:

Base URL
https://proforms.io/api/v1

Quick Start

Get up and running in 3 steps:

1

Create an API Key

Go to Dashboard → Settings → API Keys and create a new key. Copy the secret — it's only shown once.

2

Make Your First Request

List all your forms with a simple GET request:

Example Request
curl https://proforms.io/api/v1/forms \
  -H "Authorization: Bearer pf_your_api_key_here"
3

Get Your Response

All responses are JSON with a consistent format:

Example Response
{
  "success": true,
  "data": {
    "forms": [
      {
        "id": "f_abc123",
        "name": "Contact Form",
        "status": "published",
        "submissionCount": 42
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 25
  }
}
💡
Every response includes a success field. Check this before reading the data payload.

Response Format

All successful responses follow this structure:

Success Response
{
  "success": true,
  "data": {
    "...": "resource data here"
  }
}

Error responses include an error code and message:

Error Response
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Form not found"
  }
}