Skip to main content
GET
/
api
/
v1
/
forms
/
{id}
/
submissions
curl -X GET "https://your-domain.com/api/v1/forms/form_1234567890abcdef/submissions?page=1&pageSize=5" \
  -H "Authorization: Bearer sk_live_1234567890abcdef" \
  -H "Content-Type: application/json"

{
  "data": [
    {
      "id": "submission_abc123def456",
      "data": {
        "name": "John Doe",
        "email": "[email protected]",
        "message": "I'm interested in your services. Please contact me.",
        "phone": "+1-555-123-4567"
      },
      "ipAddress": "192.168.1.100",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
      "referrer": "https://example.com/contact",
      "submittedBy": null,
      "isRead": false,
      "isStarred": true,
      "notes": "High priority - mentioned large project",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T14:22:00Z"
    },
    {
      "id": "submission_def456ghi789",
      "data": {
        "name": "Jane Smith",
        "email": "[email protected]",
        "message": "Question about pricing for enterprise plan"
      },
      "ipAddress": "203.0.113.45",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15",
      "referrer": null,
      "submittedBy": null,
      "isRead": true,
      "isStarred": false,
      "notes": null,
      "createdAt": "2024-01-14T16:45:00Z",
      "updatedAt": "2024-01-14T16:45:00Z"
    }
  ],
  "meta": {
    "total": 47,
    "page": 1,
    "pageSize": 20,
    "totalPages": 3
  }
}

​
Overview

This endpoint returns all submissions for a specific form, including the submitted data, metadata such as IP address and user agent, and administrative flags like read status and notes.

​
Authentication

​
Authorization
string
required
Bearer token with your API key: Bearer YOUR_API_KEY

​
Path Parameters

​
id
string
required
The unique identifier of the form whose submissions you want to retrieve

​
Query Parameters

​
page
integer
default:"1"
Page number for pagination. Must be 1 or greater.
​
pageSize
integer
default:"20"
Number of items per page. Must be between 1 and 100.

​
Response

​
data
array
Array of form submission objects
​
meta
object
Pagination metadata
curl -X GET "https://your-domain.com/api/v1/forms/form_1234567890abcdef/submissions?page=1&pageSize=5" \
  -H "Authorization: Bearer sk_live_1234567890abcdef" \
  -H "Content-Type: application/json"

{
  "data": [
    {
      "id": "submission_abc123def456",
      "data": {
        "name": "John Doe",
        "email": "[email protected]",
        "message": "I'm interested in your services. Please contact me.",
        "phone": "+1-555-123-4567"
      },
      "ipAddress": "192.168.1.100",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
      "referrer": "https://example.com/contact",
      "submittedBy": null,
      "isRead": false,
      "isStarred": true,
      "notes": "High priority - mentioned large project",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T14:22:00Z"
    },
    {
      "id": "submission_def456ghi789",
      "data": {
        "name": "Jane Smith",
        "email": "[email protected]",
        "message": "Question about pricing for enterprise plan"
      },
      "ipAddress": "203.0.113.45",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15",
      "referrer": null,
      "submittedBy": null,
      "isRead": true,
      "isStarred": false,
      "notes": null,
      "createdAt": "2024-01-14T16:45:00Z",
      "updatedAt": "2024-01-14T16:45:00Z"
    }
  ],
  "meta": {
    "total": 47,
    "page": 1,
    "pageSize": 20,
    "totalPages": 3
  }
}

​
Error Responses

{
  "error": "resource_not_found",
  "message": "The requested form was not found"
}

​
Use Cases

​
Export Form Data

Retrieve all submissions for data analysis, reporting, or backup purposes.

​
Customer Relationship Management

Integrate form submissions into your CRM system to track leads and customer inquiries.

​
Automated Processing

Set up automated workflows to process new form submissions based on their content.

​
Analytics and Reporting

Analyze submission patterns, response rates, and form performance metrics.

​
Data Structure Notes

​
Submission Data Field

The data field contains the actual form submission data. The structure depends on your form configuration:
  • Text fields: String values
  • Email fields: Email addresses as strings
  • Number fields: Numeric values
  • Checkbox fields: Boolean values or arrays for multiple selections
  • File uploads: File metadata objects

​
Timestamps

All timestamps are in ISO 8601 format with UTC timezone. Convert to your local timezone as needed for display purposes.

​
Privacy Considerations

IP addresses and user agent strings are collected for security and analytics purposes. Ensure compliance with your privacy policy and applicable data protection regulations.
  • List Forms - Get all forms to find the form ID you need