Get Form

Retrieve the full details of a single form, including fields, settings, theme, and notification config.

forms.view
GET/v1/forms/:id

Path Parameters

id*stringThe form UUID

Example Request

curl
curl "https://proforms.io/api/v1/forms/f_abc123" \
  -H "Authorization: Bearer pf_your_api_key"

Response

200 OK
{
  "success": true,
  "data": {
    "id": "f_abc123",
    "name": "Contact Form",
    "title": "Get in Touch",
    "description": "Main website contact form",
    "fields": [
      {
        "key": "name",
        "type": "name",
        "label": "Your Name",
        "required": true,
        "width": "full",
        "order": 0
      },
      {
        "key": "email",
        "type": "email",
        "label": "Email",
        "required": true,
        "width": "half",
        "order": 1
      }
    ],
    "conditions": [],
    "settings": {
      "submitButtonText": "Submit",
      "successAction": "message",
      "successConfig": {
        "heading": "Thank you!",
        "body": "Your submission has been received."
      },
      "honeypotEnabled": true,
      "rateLimitPerIp": 5
    },
    "theme": {
      "primaryColor": "#10b981",
      "borderRadius": "8px"
    },
    "customCss": null,
    "embedMode": "inline",
    "status": "published",
    "version": 3,
    "submissionCount": 142,
    "lastSubmissionAt": "2026-02-17T08:30:00.000Z",
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-02-10T14:20:00.000Z",
    "site": {
      "id": "s_xyz789",
      "name": "Main Website",
      "domain": "example.com"
    },
    "notifications": [
      {
        "id": 1,
        "type": "admin",
        "enabled": true,
        "recipients": "admin@example.com,team@example.com",
        "subjectTemplate": "New submission: {form_name}",
        "bodyTemplate": null,
        "replyTo": "{email}",
        "fromName": "ProForms",
        "includeData": true
      },
      {
        "id": 2,
        "type": "autoresponder",
        "enabled": true,
        "recipients": null,
        "subjectTemplate": "Thanks for reaching out — {site_name}",
        "bodyTemplate": "Hi {name},\n\nThanks for your message! We'll get back to you within 24 hours.\n\n{site_name}",
        "replyTo": null,
        "fromName": "ProForms",
        "includeData": false
      }
    ]
  }
}