Submissions API
API Reference
Submissions API
Retrieve and manage form submissions. Each submission contains the user's responses and metadata.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/forms/{form_id}/submissions | List submissions for a form |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number (default: 1) |
| per_page | integer | Results per page (default: 20, max: 100) |
| since | string | Filter submissions after this ISO 8601 date |
| until | string | Filter submissions before this ISO 8601 date |
| status | string | Filter by status: completed or partial |
Example Response
GET /v1/forms/{form_id}/submissions
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"fields": {
"email": "user@example.com",
"message": "Hello, I have a question..."
},
"status": "completed",
"submitted_at": "2024-01-15T14:30:00Z",
"metadata": {
"referrer": "https://example.com",
"user_agent": "Mozilla/5.0...",
"device_type": "desktop",
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "spring_sale"
}
}
],
"meta": {
"total": 150,
"page": 1,
"per_page": 20,
"total_pages": 8
}
}