API v2 Documentation (Draft)
Client API > Response
Client API > Contacts
Client API > Display
Client API > Environment
Client API > User
Client API > File Upload
Roles
Me
Management API > Responses
Management API > Contacts
Management API > Contact Attribute Keys
Management API > Surveys > Contact Links
Management API > Webhooks
Organizations API > Teams
Organizations API > Project Teams
Organizations API > Users
Get responses
Gets responses from the database.
GET
/
responses
curl --request GET \
--url https://app.formbricks.com/api/v2/management/responses \
--header 'x-api-key: <api-key>'
{
"data": [
{
"id": "<string>",
"createdAt": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"finished": true,
"surveyId": "<string>",
"contactId": "<string>",
"endingId": "<string>",
"data": {
"question1": "answer1",
"question2": 2,
"question3": [
"answer3",
"answer4"
],
"question4": {
"subquestion1": "answer5"
}
},
"variables": {
"variable1": "answer1",
"variable2": 2
},
"ttc": {
"question1": 10,
"question2": 20
},
"meta": {
"source": "https://example.com",
"url": "https://example.com",
"userAgent": {
"browser": "Chrome",
"os": "Windows",
"device": "Desktop"
},
"country": "US",
"action": "click"
},
"contactAttributes": {
"attribute1": "value1",
"attribute2": "value2"
},
"singleUseId": "<string>",
"language": "en",
"displayId": "<string>"
}
],
"meta": {
"total": 123,
"limit": 123,
"offset": 123
}
}
Authorizations
Use your Formbricks x-api-key to authenticate.
Query Parameters
Number of items to return
Required range:
1 <= x <= 250
Number of items to skip
Required range:
x >= 0
Sort by field
Available options:
createdAt
, updatedAt
Sort order
Available options:
asc
, desc
Start date
End date
Response
200 - application/json
Responses retrieved successfully.
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://app.formbricks.com/api/v2/management/responses \
--header 'x-api-key: <api-key>'
{
"data": [
{
"id": "<string>",
"createdAt": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"finished": true,
"surveyId": "<string>",
"contactId": "<string>",
"endingId": "<string>",
"data": {
"question1": "answer1",
"question2": 2,
"question3": [
"answer3",
"answer4"
],
"question4": {
"subquestion1": "answer5"
}
},
"variables": {
"variable1": "answer1",
"variable2": 2
},
"ttc": {
"question1": 10,
"question2": 20
},
"meta": {
"source": "https://example.com",
"url": "https://example.com",
"userAgent": {
"browser": "Chrome",
"os": "Windows",
"device": "Desktop"
},
"country": "US",
"action": "click"
},
"contactAttributes": {
"attribute1": "value1",
"attribute2": "value2"
},
"singleUseId": "<string>",
"language": "en",
"displayId": "<string>"
}
],
"meta": {
"total": 123,
"limit": 123,
"offset": 123
}
}