P
ProFormsDocs

List Forms

Retrieve a paginated list of forms in your organization.

forms.view
GET/v1/forms

Query Parameters

siteIdstring

Filter forms by site UUID

statusstring

Filter by status: draft, published, archived, or all (default: excludes archived)

searchstring

Search by form name

pageinteger

Page number (default: 1)

limitinteger

Results per page, 1–100 (default: 25)

sortBystring

Sort field: name, status, submissionCount, lastSubmissionAt, createdAt, updatedAt, site (default: updatedAt)

sortDirstring

Sort direction: asc, desc (default: desc)

Example Request

curl
curl "https://proforms.io/api/v1/forms?status=published&limit=10" \
  -H "Authorization: Bearer pf_your_api_key"

Response

200 OK
{
  "success": true,
  "data": {
    "forms": [
      {
        "id": "f_abc123",
        "name": "Contact Form",
        "title": "Get in Touch",
        "description": "Main website contact form",
        "status": "published",
        "embedMode": "inline",
        "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"
        }
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 10,
    "totalPages": 1
  }
}