API v1 Documentation
Client API > Response
Client API > Contacts
Client API > Display
Client API > Environment
Client API > User
Management API > Action Class
Management API > Attribute Class
Management API > Contact Attribute Keys
Management API > Contact Attributes
Management API > Contacts
Management API > Me
Management API > People
Management API > Response
Management API > Storage
Management API > Survey
Management API > Webhook
Health
Get Survey Responses
Pass the surveyId as a Query Parameter & only fetch responses for a specific survey that you have access to.
GET
/
api
/
v1
/
management
/
responses
curl --request GET \
--url http:///%7B{baseurl}%7D/api/v1/management/responses \
--header 'x-api-key: <x-api-key>'
{
"data": [
{
"createdAt": "2024-04-23T08:03:32.901Z",
"data": {
"1": "clicked",
"hs8yd14l9h8u353tjmv6rzaw": "clicked",
"hs8yd14l9h8u353tjmv6rzawqqq": "clicked",
"tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?",
"tcgls012312312063n8ri7dtrbnepcmz": "Who? Who? Who?"
},
"finished": true,
"id": "clvc3n6hy000u494jn2ypw30r",
"language": null,
"meta": {
"action": "test action",
"source": "Postman API",
"url": "https://postman.com",
"userAgent": {}
},
"notes": [],
"person": {
"attributes": {
"Created From": "API",
"created_from": "API"
},
"createdAt": "2024-04-23T07:39:22.696Z",
"environmentId": "clurwouax000azffxt7n5unn3",
"id": "clvc2s3ig000k494jltkqkm2u",
"updatedAt": "2024-04-23T07:39:22.696Z",
"userId": "THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING"
},
"personAttributes": {
"Created From": "API",
"created_from": "API"
},
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-23T08:14:12.343Z"
},
{
"createdAt": "2024-04-23T08:00:01.151Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked",
"tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?"
},
"finished": false,
"id": "clvc3in3z000t494j4wtax1oi",
"language": null,
"meta": {
"userAgent": {}
},
"notes": [],
"person": {
"attributes": {
"Created From": "API",
"created_from": "API"
},
"createdAt": "2024-04-23T07:39:22.696Z",
"environmentId": "clurwouax000azffxt7n5unn3",
"id": "clvc2s3ig000k494jltkqkm2u",
"updatedAt": "2024-04-23T07:39:22.696Z",
"userId": "THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING"
},
"personAttributes": {
"Created From": "API",
"created_from": "API"
},
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-23T08:00:01.151Z"
},
{
"createdAt": "2024-04-23T07:59:49.759Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked",
"tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?"
},
"finished": true,
"id": "clvc3iebk000s494j37tq10o3",
"language": null,
"meta": {
"userAgent": {}
},
"notes": [],
"person": {
"attributes": {
"Created From": "API",
"created_from": "API"
},
"createdAt": "2024-04-23T07:39:22.696Z",
"environmentId": "clurwouax000azffxt7n5unn3",
"id": "clvc2s3ig000k494jltkqkm2u",
"updatedAt": "2024-04-23T07:39:22.696Z",
"userId": "THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING"
},
"personAttributes": {
"Created From": "API",
"created_from": "API"
},
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-23T07:59:49.759Z"
},
{
"createdAt": "2024-04-23T07:57:27.583Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "ho ho ho",
"tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?"
},
"finished": true,
"id": "clvc3fcm7000r494jgvs99mqa",
"language": null,
"meta": {
"userAgent": {}
},
"notes": [],
"person": {
"attributes": {
"Created From": "API",
"created_from": "API"
},
"createdAt": "2024-04-23T07:39:22.696Z",
"environmentId": "clurwouax000azffxt7n5unn3",
"id": "clvc2s3ig000k494jltkqkm2u",
"updatedAt": "2024-04-23T07:39:22.696Z",
"userId": "THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING"
},
"personAttributes": {
"Created From": "API",
"created_from": "API"
},
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-23T07:57:27.583Z"
},
{
"createdAt": "2024-04-23T07:56:59.441Z",
"data": {
"hs7yd14l9h8u353tjmv6rzaw": "clicked",
"tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?"
},
"finished": true,
"id": "clvc3eqwj000q494jali1xhzq",
"language": null,
"meta": {
"userAgent": {}
},
"notes": [],
"person": {
"attributes": {
"Created From": "API",
"created_from": "API"
},
"createdAt": "2024-04-23T07:39:22.696Z",
"environmentId": "clurwouax000azffxt7n5unn3",
"id": "clvc2s3ig000k494jltkqkm2u",
"updatedAt": "2024-04-23T07:39:22.696Z",
"userId": "THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING"
},
"personAttributes": {
"Created From": "API",
"created_from": "API"
},
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-23T07:56:59.441Z"
},
{
"createdAt": "2024-04-23T07:53:49.935Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked",
"tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?"
},
"finished": true,
"id": "clvc3aool000p494jzjuukfzu",
"language": null,
"meta": {
"userAgent": {}
},
"notes": [],
"person": {
"attributes": {
"Created From": "API",
"created_from": "API"
},
"createdAt": "2024-04-23T07:39:22.696Z",
"environmentId": "clurwouax000azffxt7n5unn3",
"id": "clvc2s3ig000k494jltkqkm2u",
"updatedAt": "2024-04-23T07:39:22.696Z",
"userId": "THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING"
},
"personAttributes": {
"Created From": "API",
"created_from": "API"
},
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-23T07:53:49.935Z"
},
{
"createdAt": "2024-04-12T13:49:47.746Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked",
"inputType": "text",
"tcgls0063n8ri7dtrbnepcmz": "fsef"
},
"finished": true,
"id": "cluwq6352000klvz6t82e1oyt",
"language": null,
"meta": {
"action": "New Session",
"url": "http://localhost:3002/app?formbricksDebug=true",
"userAgent": {
"browser": "Chrome",
"os": "Linux"
}
},
"notes": [],
"person": null,
"personAttributes": null,
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {
"_total": 6908,
"hs8yd14l9h8u353tjmv6rzaw": 4094.60000000149,
"tcgls0063n8ri7dtrbnepcmz": 2813.39999999851
},
"updatedAt": "2024-04-12T13:53:24.650Z"
},
{
"createdAt": "2024-04-12T13:09:54.616Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked"
},
"finished": false,
"id": "cluwoqsl4000ilvz6xmbaf5fl",
"language": null,
"meta": {
"action": "New Session",
"url": "http://localhost:3002/app?formbricksDebug=true",
"userAgent": {
"browser": "Chrome",
"os": "Linux"
}
},
"notes": [],
"person": null,
"personAttributes": null,
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-12T13:09:54.616Z"
},
{
"createdAt": "2024-04-12T13:09:19.823Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked",
"inputType": "text",
"tcgls0063n8ri7dtrbnepcmz": "aaa"
},
"finished": true,
"id": "cluwoq1qn000glvz6ntrzf3kc",
"language": null,
"meta": {
"action": "New Session",
"url": "http://localhost:3002/app?formbricksDebug=true",
"userAgent": {
"browser": "Chrome",
"os": "Linux"
}
},
"notes": [],
"person": null,
"personAttributes": null,
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {
"_total": 4311.599999997765,
"hs8yd14l9h8u353tjmv6rzaw": 2231.199999999255,
"tcgls0063n8ri7dtrbnepcmz": 2080.39999999851
},
"updatedAt": "2024-04-12T13:09:23.793Z"
},
{
"createdAt": "2024-04-12T13:08:58.008Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked"
},
"finished": false,
"id": "cluwopkwr000dlvz6mxvueqm8",
"language": null,
"meta": {
"action": "New Session",
"url": "http://localhost:3002/app?formbricksDebug=true",
"userAgent": {
"browser": "Chrome",
"os": "Linux"
}
},
"notes": [],
"person": null,
"personAttributes": null,
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-12T13:08:58.008Z"
},
{
"createdAt": "2024-04-12T13:07:01.174Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked"
},
"finished": true,
"id": "cluwon2ra000clvz6pwo3b5g3",
"language": null,
"meta": {
"action": "New Session",
"url": "http://localhost:3002/app?formbricksDebug=true",
"userAgent": {
"browser": "Chrome",
"os": "Linux"
}
},
"notes": [],
"person": null,
"personAttributes": null,
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-12T13:07:01.174Z"
}
]
}
Headers
Query Parameters
Response
200 - application/json
OK
The response is of type object
.
Was this page helpful?
curl --request GET \
--url http:///%7B{baseurl}%7D/api/v1/management/responses \
--header 'x-api-key: <x-api-key>'
{
"data": [
{
"createdAt": "2024-04-23T08:03:32.901Z",
"data": {
"1": "clicked",
"hs8yd14l9h8u353tjmv6rzaw": "clicked",
"hs8yd14l9h8u353tjmv6rzawqqq": "clicked",
"tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?",
"tcgls012312312063n8ri7dtrbnepcmz": "Who? Who? Who?"
},
"finished": true,
"id": "clvc3n6hy000u494jn2ypw30r",
"language": null,
"meta": {
"action": "test action",
"source": "Postman API",
"url": "https://postman.com",
"userAgent": {}
},
"notes": [],
"person": {
"attributes": {
"Created From": "API",
"created_from": "API"
},
"createdAt": "2024-04-23T07:39:22.696Z",
"environmentId": "clurwouax000azffxt7n5unn3",
"id": "clvc2s3ig000k494jltkqkm2u",
"updatedAt": "2024-04-23T07:39:22.696Z",
"userId": "THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING"
},
"personAttributes": {
"Created From": "API",
"created_from": "API"
},
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-23T08:14:12.343Z"
},
{
"createdAt": "2024-04-23T08:00:01.151Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked",
"tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?"
},
"finished": false,
"id": "clvc3in3z000t494j4wtax1oi",
"language": null,
"meta": {
"userAgent": {}
},
"notes": [],
"person": {
"attributes": {
"Created From": "API",
"created_from": "API"
},
"createdAt": "2024-04-23T07:39:22.696Z",
"environmentId": "clurwouax000azffxt7n5unn3",
"id": "clvc2s3ig000k494jltkqkm2u",
"updatedAt": "2024-04-23T07:39:22.696Z",
"userId": "THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING"
},
"personAttributes": {
"Created From": "API",
"created_from": "API"
},
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-23T08:00:01.151Z"
},
{
"createdAt": "2024-04-23T07:59:49.759Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked",
"tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?"
},
"finished": true,
"id": "clvc3iebk000s494j37tq10o3",
"language": null,
"meta": {
"userAgent": {}
},
"notes": [],
"person": {
"attributes": {
"Created From": "API",
"created_from": "API"
},
"createdAt": "2024-04-23T07:39:22.696Z",
"environmentId": "clurwouax000azffxt7n5unn3",
"id": "clvc2s3ig000k494jltkqkm2u",
"updatedAt": "2024-04-23T07:39:22.696Z",
"userId": "THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING"
},
"personAttributes": {
"Created From": "API",
"created_from": "API"
},
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-23T07:59:49.759Z"
},
{
"createdAt": "2024-04-23T07:57:27.583Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "ho ho ho",
"tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?"
},
"finished": true,
"id": "clvc3fcm7000r494jgvs99mqa",
"language": null,
"meta": {
"userAgent": {}
},
"notes": [],
"person": {
"attributes": {
"Created From": "API",
"created_from": "API"
},
"createdAt": "2024-04-23T07:39:22.696Z",
"environmentId": "clurwouax000azffxt7n5unn3",
"id": "clvc2s3ig000k494jltkqkm2u",
"updatedAt": "2024-04-23T07:39:22.696Z",
"userId": "THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING"
},
"personAttributes": {
"Created From": "API",
"created_from": "API"
},
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-23T07:57:27.583Z"
},
{
"createdAt": "2024-04-23T07:56:59.441Z",
"data": {
"hs7yd14l9h8u353tjmv6rzaw": "clicked",
"tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?"
},
"finished": true,
"id": "clvc3eqwj000q494jali1xhzq",
"language": null,
"meta": {
"userAgent": {}
},
"notes": [],
"person": {
"attributes": {
"Created From": "API",
"created_from": "API"
},
"createdAt": "2024-04-23T07:39:22.696Z",
"environmentId": "clurwouax000azffxt7n5unn3",
"id": "clvc2s3ig000k494jltkqkm2u",
"updatedAt": "2024-04-23T07:39:22.696Z",
"userId": "THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING"
},
"personAttributes": {
"Created From": "API",
"created_from": "API"
},
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-23T07:56:59.441Z"
},
{
"createdAt": "2024-04-23T07:53:49.935Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked",
"tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?"
},
"finished": true,
"id": "clvc3aool000p494jzjuukfzu",
"language": null,
"meta": {
"userAgent": {}
},
"notes": [],
"person": {
"attributes": {
"Created From": "API",
"created_from": "API"
},
"createdAt": "2024-04-23T07:39:22.696Z",
"environmentId": "clurwouax000azffxt7n5unn3",
"id": "clvc2s3ig000k494jltkqkm2u",
"updatedAt": "2024-04-23T07:39:22.696Z",
"userId": "THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING"
},
"personAttributes": {
"Created From": "API",
"created_from": "API"
},
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-23T07:53:49.935Z"
},
{
"createdAt": "2024-04-12T13:49:47.746Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked",
"inputType": "text",
"tcgls0063n8ri7dtrbnepcmz": "fsef"
},
"finished": true,
"id": "cluwq6352000klvz6t82e1oyt",
"language": null,
"meta": {
"action": "New Session",
"url": "http://localhost:3002/app?formbricksDebug=true",
"userAgent": {
"browser": "Chrome",
"os": "Linux"
}
},
"notes": [],
"person": null,
"personAttributes": null,
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {
"_total": 6908,
"hs8yd14l9h8u353tjmv6rzaw": 4094.60000000149,
"tcgls0063n8ri7dtrbnepcmz": 2813.39999999851
},
"updatedAt": "2024-04-12T13:53:24.650Z"
},
{
"createdAt": "2024-04-12T13:09:54.616Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked"
},
"finished": false,
"id": "cluwoqsl4000ilvz6xmbaf5fl",
"language": null,
"meta": {
"action": "New Session",
"url": "http://localhost:3002/app?formbricksDebug=true",
"userAgent": {
"browser": "Chrome",
"os": "Linux"
}
},
"notes": [],
"person": null,
"personAttributes": null,
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-12T13:09:54.616Z"
},
{
"createdAt": "2024-04-12T13:09:19.823Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked",
"inputType": "text",
"tcgls0063n8ri7dtrbnepcmz": "aaa"
},
"finished": true,
"id": "cluwoq1qn000glvz6ntrzf3kc",
"language": null,
"meta": {
"action": "New Session",
"url": "http://localhost:3002/app?formbricksDebug=true",
"userAgent": {
"browser": "Chrome",
"os": "Linux"
}
},
"notes": [],
"person": null,
"personAttributes": null,
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {
"_total": 4311.599999997765,
"hs8yd14l9h8u353tjmv6rzaw": 2231.199999999255,
"tcgls0063n8ri7dtrbnepcmz": 2080.39999999851
},
"updatedAt": "2024-04-12T13:09:23.793Z"
},
{
"createdAt": "2024-04-12T13:08:58.008Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked"
},
"finished": false,
"id": "cluwopkwr000dlvz6mxvueqm8",
"language": null,
"meta": {
"action": "New Session",
"url": "http://localhost:3002/app?formbricksDebug=true",
"userAgent": {
"browser": "Chrome",
"os": "Linux"
}
},
"notes": [],
"person": null,
"personAttributes": null,
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-12T13:08:58.008Z"
},
{
"createdAt": "2024-04-12T13:07:01.174Z",
"data": {
"hs8yd14l9h8u353tjmv6rzaw": "clicked"
},
"finished": true,
"id": "cluwon2ra000clvz6pwo3b5g3",
"language": null,
"meta": {
"action": "New Session",
"url": "http://localhost:3002/app?formbricksDebug=true",
"userAgent": {
"browser": "Chrome",
"os": "Linux"
}
},
"notes": [],
"person": null,
"personAttributes": null,
"singleUseId": null,
"surveyId": "clusgqpml0000135cxet3y8vh",
"tags": [],
"ttc": {},
"updatedAt": "2024-04-12T13:07:01.174Z"
}
]
}