Request
Learn how to create an API key in the API Keys documentation.
Copy
Ask AI
curl -X GET 'https://forms.withsurface.com/api/v1/responses' \
-H 'x-api-key: your-api-key-here'
Response
Array of response objects for all forms in your environment.
Show Response object properties
Show Response object properties
Unique identifier for the response.
ISO 8601 timestamp of when the response was created.
ISO 8601 timestamp of when the response was last updated.
ISO 8601 timestamp of when the response data was last updated.
Whether the response is complete (true) or partial (false).
Status code of the response.
ID of the form this response belongs to.
Version of the response format.
Array of question responses, each containing a
response object and questionId. Each response object follows a specific shape based on the component type. See the Component Response Shapes documentation for details on all supported component types.Metadata associated with the response, including
leadId.Attributes about the person who submitted the response, including IP address, country, and form visit statistics.
Example Response
Copy
Ask AI
{
"data": [
{
"id": "cmasda085pa0018js0barsadxn5b",
"createdAt": "2026-01-20T19:45:59.519Z",
"updatedAt": "2026-01-20T19:46:37.149Z",
"dataUpdatedAt": "2026-01-20T19:46:01.725Z",
"finished": true,
"status": 4,
"formId": "casdkgkufzp0001kw0btrmz1asd",
"version": "2.0",
"data": [
{
"response": {
"type": "IdentityInfo",
"headline": "Identity Info",
"emailAddress": "john.doe@example.com",
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"componentShapeVersion": "2.0"
},
"questionId": "gOyoYYzZRnvo"
},
],
"meta": {
"leadId": "lead_1234567890"
},
"personAttributes": {
"ip": "123.45.67.89",
"country": "United States",
"visitedForm": 1,
"completedForm": 0
}
},
]
}