List Submissions
Retrieve a paginated list of form submissions with filtering and search.
submissions.view
GET
/v1/submissionsQuery Parameters
| Parameter | Type | Description |
|---|---|---|
| formId | string | Filter by form UUID |
| siteId | string | Filter by site UUID |
| isRead | string | Filter by read status: true or false |
| isStarred | string | Filter by starred status: true or false |
| search | string | Search across submission data |
| preset | string | Date preset: today, yesterday, 7d, 30d, 90d, 12m |
| startDate | string | Custom start date (ISO 8601) |
| endDate | string | Custom end date (ISO 8601) |
| page | integer | Page number (default: 1) |
| limit | integer | Results per page, 1–100 (default: 25) |
| sortBy | string | Sort field: createdAt, updatedAt (default: createdAt) |
| sortOrder | string | Sort direction: asc, desc (default: desc) |
Example Request
curl
curl "https://proforms.io/api/v1/submissions?formId=f_abc123&isRead=false&limit=10" \
-H "Authorization: Bearer pf_your_api_key"Response
200 OK
{
"success": true,
"data": {
"submissions": [
{
"id": "sub_def456",
"referenceId": "CF-0042",
"formId": "f_abc123",
"formName": "Contact Form",
"siteId": "s_xyz789",
"siteName": "Main Website",
"data": {
"name": "John Smith",
"email": "john@example.com",
"message": "I'd like a quote for web design"
},
"isRead": false,
"isStarred": false,
"isSpam": false,
"ipAddress": "192.168.1.1",
"userAgent": "Mozilla/5.0...",
"referrer": "https://example.com/contact",
"createdAt": "2026-02-17T09:15:00.000Z"
}
],
"total": 42,
"page": 1,
"limit": 10,
"totalPages": 5
}
}