Formbricks offers two types of APIs: the Public Client API and the Management API. Each API serves a different purpose, has different authentication requirements, and provides access to different data and settings.
\nCheckout the API Key Setup - to access the Management APIs wit an API Key.
\n\n\nIf you have forked the collection & running it, we recommend you to atleast update
\napiKey&environmentIdthe Collection variables as per your values! We also have a lot of post-run scripts written to help you navigate through auto-assigning variables when running scripts.
Need more help, visit our: Website or join our Discord!
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11026000","collectionId":"927c954f-85a9-4f8f-b0ec-14191b903737","publishedId":"2sA3Bq5XEh","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-04-23T12:57:58.000Z"},"item":[{"name":"Client API","item":[{"name":"Action","item":[{"name":"Add Action for User","id":"bd57724b-0dc2-47ad-8c2c-dd4138afe1f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING\",\n \"name\": \"new_action_v1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/actions","description":"Create a new action for a user. A new action class is created if the action name does not exist in the environment.
\n","urlObject":{"path":["api","v1","client","clurwouax000azffxt7n5unn3","actions"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"8e5cfbf8-5094-4308-a9d0-366483e1a05f","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING\",\n \"name\": \"new_action_v1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/actions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 07:11:17 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {}\n}"},{"id":"1dff3302-cd23-4cb9-8769-ba37370f3ae7","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"1\",\n \"name\": \"new_action_v3\",\n \"properties\":{}\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clonzr6vc0009z8md7y06hipl/actions"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 07:07:03 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"internal_server_error\",\n \"message\": \"Unable to handle the request: Database error when creating an action for environment clonzr6vc0009z8md7y06hipl\",\n \"details\": {}\n}"}],"_postman_id":"bd57724b-0dc2-47ad-8c2c-dd4138afe1f3"}],"id":"b8f3a10e-1642-4d82-a629-fef0a8c6c86c","description":"Actions taken by a user in your application. Saved actions can be used in Advanced Targeting to display surveys based on past behavior.
\n","_postman_id":"b8f3a10e-1642-4d82-a629-fef0a8c6c86c"},{"name":"Display","item":[{"name":"Create Display","event":[{"listen":"test","script":{"id":"d9166870-c955-47d0-8ff6-8cf10219358f","exec":["var response = pm.response.json();","pm.collectionVariables.set(\"displayId\", response.data.id);",""],"type":"text/javascript","packages":{}}}],"id":"405e597e-aa6e-4f57-8819-d1922fde2b85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"userId\": \"THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING\" // OPTIONAL\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/displays","description":"Create a new display for a valid survey ID. If a userId is passed, the display is linked to the user.
\n","urlObject":{"path":["api","v1","client","clurwouax000azffxt7n5unn3","displays"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"04ca4fd0-a31f-47fd-9e90-3c727c51529a","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"surveyId\": \"cloo31fnc0000z8jo0dq29z17\",\n \"userId\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/displays"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"Access-Control-Allow-Headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 07:12:51 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"internal_server_error\",\n \"message\": \"\\nInvalid `prisma.display.create()` invocation:\\n\\n\\nAn operation failed because it depends on one or more records that were required but not found. No 'Survey' record(s) (needed to inline the relation on 'Display' record(s)) was found for a nested connect on one-to-many relation 'DisplayToSurvey'.\",\n \"details\": {}\n}"},{"id":"2d4e8340-78a1-42d5-8d8f-f33b771de0c6","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"userId\": \"THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/displays"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 07:16:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clvc1z8200006494jgnds7ort\"\n }\n}"}],"_postman_id":"405e597e-aa6e-4f57-8819-d1922fde2b85"},{"name":"Update Display","id":"5da8a58c-6b49-46bd-9ff1-7c49bd236d4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"userId\":\"THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING\", // OPTIONAL\n \"responseId\":\"clvc3aool000p494jzjuukfzu\" // OPTIONAL\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/displays/clvc1z8200006494jgnds7ora","description":"Update an Display for a user. A use case can be when a user submits a response & you want to link it to an existing display.
\n","urlObject":{"path":["api","v1","client","clurwouax000azffxt7n5unn3","displays","clvc1z8200006494jgnds7ora"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"9260b4f0-d54b-48a0-a7a4-d03b2a8626f2","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"userId\":\"2\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/displays/clvc1z8200006494jgnds7ora"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 07:26:06 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"internal_server_error\",\n \"message\": \"Person with ID 2 not found\",\n \"details\": {}\n}"},{"id":"e4649737-9425-4437-b779-be4ae49a8360","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"userId\":\"THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/displays/clvc1z8200006494jgnds7ora"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 07:26:39 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {}\n}"}],"_postman_id":"5da8a58c-6b49-46bd-9ff1-7c49bd236d4f"}],"id":"949272bf-daec-4d72-9b52-47af3d74a62c","description":"Displays are metrics used to measure the number of times a survey was viewed both by unidentified or identified users.
\n","_postman_id":"949272bf-daec-4d72-9b52-47af3d74a62c"},{"name":"People","item":[{"name":"Create Person","event":[{"listen":"prerequest","script":{"id":"637d59b8-09e3-4d21-8602-fae4eb23ba35","exec":["const existingUserId = pm.collectionVariables.get(\"userId\");","","pm.collectionVariables.set(\"userId\", existingUserId + \"1\");",""],"type":"text/javascript","packages":{}}}],"id":"1e695c10-60ce-49fd-857c-792510909de1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\":\"THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/people","description":"Creates a person in Formbricks with the given userId, it must be unique.
\n","urlObject":{"path":["api","v1","client","clurwouax000azffxt7n5unn3","people"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"874d8fd9-a5ed-410f-806e-c10ce85c7da1","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\":\"clvc1tuo00003494jnz64wd0t\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/people"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 07:35:47 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"userId\": \"Shubham\"\n }\n}"},{"id":"5f885413-f292-4b94-8e97-ec134f3b8ab2","name":"Bad Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n // \"userId\":\"clvc1tuo00003494jnz64wd0t\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/people"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 07:36:43 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"bad_request\",\n \"message\": \"userId is required\",\n \"details\": {\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n }\n}"}],"_postman_id":"1e695c10-60ce-49fd-857c-792510909de1"},{"name":"Update Person","id":"428d9dcf-5ba7-45b0-9edf-ca89e0b97542","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"attributes\":{\n \"Created From\":\"API\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/people/THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING/attributes","description":"Update a person's attributes in Formbricks to keep them in sync with your app or when you want to set a custom attribute in Formbricks.
\n","urlObject":{"path":["api","v1","client","clurwouax000azffxt7n5unn3","people","THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING","attributes"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"ad34dfe7-6ecc-4244-b3a8-f2632d10d416","name":"Success (New Attributes)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"attributes\":{\n \"Created From\":\"API\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/people/THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 07:42:32 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"changed\": true,\n \"message\": \"The person was successfully updated.\"\n }\n}"},{"id":"20ea9f2f-1448-4b73-8ec3-34febf1b18b7","name":"Success (Same Attributes)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"attributes\":{\n \"Created From\":\"API\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/people/THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 07:43:04 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"changed\": false,\n \"message\": \"No updates were necessary; the person is already up to date.\"\n }\n}"},{"id":"209ac591-6304-4074-a636-c923799236fe","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"attributes\":{\n 91:\"API\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/people/THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 07:43:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"internal_server_error\",\n \"message\": \"Unable to complete request: Expected property name or '}' in JSON at position 29\",\n \"details\": {}\n}"}],"_postman_id":"428d9dcf-5ba7-45b0-9edf-ca89e0b97542"}],"id":"ee3d2188-4253-4bca-9238-6b76455805a9","description":"Persons are the identified users on Formbricks app that get initated when you pass a userId and have user activation enabled. This now allows you to track & show them targeted surveys based on their actions, attributes, etc.
\n","_postman_id":"ee3d2188-4253-4bca-9238-6b76455805a9"},{"name":"Response","item":[{"name":"Create Response","event":[{"listen":"test","script":{"id":"f52146ce-3532-464c-86e1-220802c1f6d3","exec":["var response = pm.response.json();","pm.collectionVariables.set(\"responseId\", response.data.id);",""],"type":"text/javascript","packages":{}}}],"id":"b87a1233-e05a-4602-9730-3a6fda92a9a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"userId\": \"THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING\", // OPTIONAL\n \"finished\": false,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\", // Question IDs & their answers\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\":{ // Optional\n \"source\":\"Postman API\",\n \"url\":\"https://postman.com\",\n \"action\":\"test action\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/responses","description":"Create a response for a survey and it's fields with the user's responses. The userId & meta here is optional
\n","urlObject":{"path":["api","v1","client","clurwouax000azffxt7n5unn3","responses"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"8f46aaa5-6355-4f21-8bd6-1f1e1fd15e9b","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING\", // OPTIONAL\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/responses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 07:53:50 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clvc3aool000p494jzjuukfzu\"\n }\n}"},{"id":"6a8b4fe2-3bb7-4d39-a095-8d0a5dcc93ac","name":"Bad Request Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING\", // OPTIONAL\n \"surveyId\": \"surveyId\",\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/responses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 07:55:50 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"bad_request\",\n \"message\": \"Fields are missing or incorrectly formatted\",\n \"details\": {\n \"surveyId\": \"Invalid cuid2\"\n }\n}"},{"id":"2b7b264c-ca02-4b48-ada2-b8bce46ad7e4","name":"Not Found Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING\", // OPTIONAL\n \"surveyId\": \"hs8yd14l9h8u353tjmv6rzaw\",\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/clurwouax000azffxt7n5unn3/responses"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 07:56:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_found\",\n \"message\": \"Survey not found\",\n \"details\": {\n \"resource_id\": \"hs8yd14l9h8u353tjmv6rzaw\",\n \"resource_type\": \"Survey\"\n }\n}"}],"_postman_id":"b87a1233-e05a-4602-9730-3a6fda92a9a4"},{"name":"Update Response","id":"54e281f8-d80c-4a8c-9034-05bbdac63433","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzawqqq\": \"clicked\", // Question IDs & their answers\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/responses/clvc3aool000p494jzjuukfzu","description":"Update an existing response for example when you want to mark a response as finished or you want to change an existing response's value.
\n","urlObject":{"path":["api","v1","client","responses","clvc3aool000p494jzjuukfzu"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"d6ea16b2-8b2e-4618-8162-84810e720d29","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\", // Question IDs & their answers\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/responses/clvc3aool000p494jzjuukfzu"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 08:09:19 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {}\n}"},{"id":"33dfd2d8-de4d-48d7-b38e-845caf645543","name":"Not Found Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzawqqq\": \"clicked\", // Question IDs & their answers\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/client/responses/nonexistentid"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"access-control-allow-methods","value":"GET,OPTIONS,PATCH,DELETE,POST,PUT"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-headers","value":"X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 08:13:50 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_found\",\n \"message\": \"Response not found\",\n \"details\": {\n \"resource_id\": \"nonexistentid\",\n \"resource_type\": \"Response\"\n }\n}"}],"_postman_id":"54e281f8-d80c-4a8c-9034-05bbdac63433"}],"id":"8c773032-536c-483c-a237-c7697347946e","description":"Responses are captured whenever a user fills in your survey either partially or completely.
\n","_postman_id":"8c773032-536c-483c-a237-c7697347946e"},{"name":"Contact","item":[{"name":"User","id":"4d2fc0e4-494a-4abb-9d8a-8d723d3175f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"random-user-id-1\",\n \"attributes\": {\n \"email\":\"unique@email.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/client/cm6onj7rr0008w2ahgc4xxyxk/user","urlObject":{"protocol":"http","port":"3000","path":["api","v1","client","cm6onj7rr0008w2ahgc4xxyxk","user"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d2fc0e4-494a-4abb-9d8a-8d723d3175f4"}],"id":"2eb32b25-ae5a-44de-b69a-99c515922211","_postman_id":"2eb32b25-ae5a-44de-b69a-99c515922211","description":""}],"id":"5c981d9e-5e7d-455d-9795-b9c45bc2f930","description":"The Public Client API is designed for the JavaScript SDK and does not require authentication. It's primarily used for creating persons, sessions, and responses within the Formbricks platform. This API is ideal for client-side interactions, as it doesn't expose sensitive information.
\nFetches all the action classes available in the environment
\n","urlObject":{"path":["api","v1","management","action-classes"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"4229d94b-8386-4235-8b94-2ba81eee3963","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-Api-Key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/action-classes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 08:47:03 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"clurwouax000bzffxv3fqy6mt\",\n \"createdAt\": \"2024-04-09T04:53:29.577Z\",\n \"updatedAt\": \"2024-04-09T04:53:29.577Z\",\n \"name\": \"New Session\",\n \"description\": \"Gets fired when a new session is created\",\n \"type\": \"automatic\",\n \"noCodeConfig\": null,\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n },\n {\n \"id\": \"clurwouax000czffx4wj0qldi\",\n \"createdAt\": \"2024-04-09T04:53:29.577Z\",\n \"updatedAt\": \"2024-04-09T04:53:29.577Z\",\n \"name\": \"Exit Intent (Desktop)\",\n \"description\": \"A user on Desktop leaves the website with the cursor.\",\n \"type\": \"automatic\",\n \"noCodeConfig\": null,\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n },\n {\n \"id\": \"clurwouax000dzffx3dfxc91d\",\n \"createdAt\": \"2024-04-09T04:53:29.577Z\",\n \"updatedAt\": \"2024-04-09T04:53:29.577Z\",\n \"name\": \"50% Scroll\",\n \"description\": \"A user scrolled 50% of the current page\",\n \"type\": \"automatic\",\n \"noCodeConfig\": null,\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n },\n {\n \"id\": \"clvaq6nx40000mhqfuu74rv92\",\n \"createdAt\": \"2024-04-22T08:59:01.144Z\",\n \"updatedAt\": \"2024-04-22T09:03:55.509Z\",\n \"name\": \"new_action_v2\",\n \"description\": \"hhehe\",\n \"type\": \"code\",\n \"noCodeConfig\": null,\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n },\n {\n \"id\": \"clvaqdq8z000bmhqfu0km5rv4\",\n \"createdAt\": \"2024-04-22T09:04:30.756Z\",\n \"updatedAt\": \"2024-04-22T09:04:30.756Z\",\n \"name\": \"new_action_v20\",\n \"description\": null,\n \"type\": \"code\",\n \"noCodeConfig\": null,\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n },\n {\n \"id\": \"clvc1ryuf0001494jc8oesfwl\",\n \"createdAt\": \"2024-04-23T07:11:17.032Z\",\n \"updatedAt\": \"2024-04-23T07:11:17.032Z\",\n \"name\": \"new_action_v1\",\n \"description\": null,\n \"type\": \"code\",\n \"noCodeConfig\": null,\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n }\n ]\n}"},{"id":"8c1da145-8e40-4883-a54e-35f2251a1990","name":"Unauthorrized Error","originalRequest":{"method":"GET","header":[{"key":"x-Api-Key","value":"{{apiKey}","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/action-classes"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 08:48:01 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_authenticated\",\n \"message\": \"Not authenticated\",\n \"details\": {\n \"x-Api-Key\": \"Header not provided or API Key invalid\"\n }\n}"}],"_postman_id":"b0e74fcf-90bc-49b8-84c3-baee23f85d93"},{"name":"Get Action Class by ID","event":[{"listen":"test","script":{"id":"1590c57f-f5be-4176-8af0-caa905080d48","exec":[""],"type":"text/javascript","packages":{}}}],"id":"be425c37-a470-486a-9ecf-f698af388554","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-Api-Key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/action-classes/clurwouax000bzffxv3fqy6mt","description":"Fetch an Action Class by it's ID
\n","urlObject":{"path":["api","v1","management","action-classes","clurwouax000bzffxv3fqy6mt"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"9d219d6f-9811-4fb9-af01-63996a8376be","name":"Not Found Error","originalRequest":{"method":"GET","header":[{"key":"x-Api-Key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/action-classes/clurwouax000bzffxv3fqy6mt"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 09:01:09 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_found\",\n \"message\": \"Action Class not found\",\n \"details\": {\n \"resource_id\": \"clvc5m82c000z494jkvnw1gh0\",\n \"resource_type\": \"Action Class\"\n }\n}"},{"id":"4ddc4d57-b127-486c-a057-b799bb3ac9c4","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-Api-Key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/action-classes/clurwouax000bzffxv3fqy6mt"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 09:03:25 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clurwouax000bzffxv3fqy6mt\",\n \"createdAt\": \"2024-04-09T04:53:29.577Z\",\n \"updatedAt\": \"2024-04-09T04:53:29.577Z\",\n \"name\": \"New Session\",\n \"description\": \"Gets fired when a new session is created\",\n \"type\": \"automatic\",\n \"noCodeConfig\": null,\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n }\n}"}],"_postman_id":"be425c37-a470-486a-9ecf-f698af388554"},{"name":"Create Action Class","event":[{"listen":"test","script":{"id":"2cb2c3e7-4c77-4d13-8a34-aca9da7c8fcb","exec":["var response = pm.response.json();","pm.collectionVariables.set(\"actionClassId\", response.data.id);"],"type":"text/javascript","packages":{}}}],"id":"3bfb98e2-87a4-4f31-85b0-eb180028eb92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"name\": \"My Action from Postman\",\n \"type\": \"code\",\n \"description\": \"From API Docs\", // OPTIONAL\n \"noCodeConfig\": { // OPTIONAL\n \"type\": \"innerHtml\",\n \"innerHtml\": {\n \"value\": \"sign-up\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/action-classes","description":"Create Action Class from the UI or from the API! You can read more about them here.
\n","urlObject":{"path":["api","v1","management","action-classes"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"06d2bb11-6b8a-44f9-bdec-25cc433cfa1c","name":"Bad Request Error","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"name\": \"My new Action\",\n \"type\": \"code\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/action-classes/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 08:57:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"bad_request\",\n \"message\": \"Database error when creating an action for environment clurwouax000azffxt7n5unn3\",\n \"details\": {}\n}"},{"id":"af88bff5-447a-4914-82e5-25a1c71eebdb","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"name\": \"My Action from Postman\",\n \"type\": \"code\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/action-classes/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 08:58:47 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clvc5m82c000z494jkvnw1gh0\",\n \"createdAt\": \"2024-04-23T08:58:47.507Z\",\n \"updatedAt\": \"2024-04-23T08:58:47.507Z\",\n \"name\": \"My Action from Postman\",\n \"description\": null,\n \"type\": \"code\",\n \"noCodeConfig\": null,\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n }\n}"}],"_postman_id":"3bfb98e2-87a4-4f31-85b0-eb180028eb92"},{"name":"Delete Action Class","id":"930e2732-6b1e-4659-8d3a-9448e05c0527","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/action-classes/clurwouax000bzffxv3fqy6mt","description":"Deletes an existing action class
\n","urlObject":{"path":["api","v1","management","action-classes","clurwouax000bzffxv3fqy6mt"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"f91d9128-045c-4b75-bbb3-810e98e78d69","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/action-classes/clurwouax000bzffxv3fqy6mt"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 08:59:13 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clvc5m82c000z494jkvnw1gh0\",\n \"createdAt\": \"2024-04-23T08:58:47.507Z\",\n \"updatedAt\": \"2024-04-23T08:58:47.507Z\",\n \"name\": \"My Action from Postman\",\n \"description\": null,\n \"type\": \"code\",\n \"noCodeConfig\": null,\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n }\n}"},{"id":"5611da3f-8d1d-406e-8445-471fb9700a17","name":"Not Found Error","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/action-classes/clurwouax000bzffxv3fqy6mt"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 08:59:38 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_found\",\n \"message\": \"Action Class not found\",\n \"details\": {\n \"resource_id\": \"clvc5m82c000z494jkvnw1gh0\",\n \"resource_type\": \"Action Class\"\n }\n}"},{"id":"c23a3530-7269-4688-a97f-58ec52b9ba0e","name":"Bad Request Error","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/action-classes/clurwouax000bzffxv3fqy6mt"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 09:13:05 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"bad_request\",\n \"message\": \"Automatic action classes cannot be deleted\",\n \"details\": {}\n}"}],"_postman_id":"930e2732-6b1e-4659-8d3a-9448e05c0527"}],"id":"81947f69-99fc-41c9-a184-f3260e02be48","description":"Action Classes allow you to set behaviour methods such as when a user clicks on a buy now button, or when a user leaves the page, etc. These allow you to trigger specific surveys to these users.
\nMethods: Get All, Get, Create, Update, and Delete Action Classes
\n","_postman_id":"81947f69-99fc-41c9-a184-f3260e02be48"},{"name":"Attribute Class","item":[{"name":"Get All Attribute Classes","event":[{"listen":"test","script":{"id":"819b5f1a-5fb6-43fa-b901-ece4160cfc3a","exec":["var response = pm.response.json();","console.log(\"res\", response.data.length);","if (response.data.length > 0) {"," pm.collectionVariables.set(\"attributeClassId\", response.data[0].id);","}",""],"type":"text/javascript","packages":{}}}],"id":"667ed541-d83f-415d-99c9-d47f99806aba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/attribute-classes","description":"Fetches all the available attribute classes
\n","urlObject":{"path":["api","v1","management","attribute-classes"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"91733f6e-2040-4511-83b2-a49177fbc7a8","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/attribute-classes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 09:14:46 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"clurwouax000ezffxs7unemg2\",\n \"createdAt\": \"2024-04-09T04:53:29.577Z\",\n \"updatedAt\": \"2024-04-09T04:53:29.577Z\",\n \"name\": \"email\",\n \"description\": \"The email of the person\",\n \"archived\": false,\n \"type\": \"automatic\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n },\n {\n \"id\": \"clurwouax000fzffxv9rycait\",\n \"createdAt\": \"2024-04-09T04:53:29.577Z\",\n \"updatedAt\": \"2024-04-09T04:53:29.577Z\",\n \"name\": \"language\",\n \"description\": \"The language used by the person\",\n \"archived\": false,\n \"type\": \"automatic\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n },\n {\n \"id\": \"clvaq78470004mhqfm0x3kasv\",\n \"createdAt\": \"2024-04-22T08:59:27.319Z\",\n \"updatedAt\": \"2024-04-22T08:59:27.319Z\",\n \"name\": \"Init Attribute 2\",\n \"description\": null,\n \"archived\": false,\n \"type\": \"code\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n },\n {\n \"id\": \"clvaq78500005mhqfd8z2dnxq\",\n \"createdAt\": \"2024-04-22T08:59:27.348Z\",\n \"updatedAt\": \"2024-04-22T08:59:27.348Z\",\n \"name\": \"Init Attribute 1\",\n \"description\": null,\n \"archived\": false,\n \"type\": \"code\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n },\n {\n \"id\": \"clvc2ub5p000l494j1xwrgvqe\",\n \"createdAt\": \"2024-04-23T07:41:05.917Z\",\n \"updatedAt\": \"2024-04-23T07:41:05.917Z\",\n \"name\": \"created_from\",\n \"description\": null,\n \"archived\": false,\n \"type\": \"code\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n },\n {\n \"id\": \"clvc2w637000n494j4z3oyye3\",\n \"createdAt\": \"2024-04-23T07:42:32.659Z\",\n \"updatedAt\": \"2024-04-23T07:42:32.659Z\",\n \"name\": \"Created From\",\n \"description\": null,\n \"archived\": false,\n \"type\": \"code\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n }\n ]\n}"}],"_postman_id":"667ed541-d83f-415d-99c9-d47f99806aba"},{"name":"Get Attribute Class by ID","id":"11bdee31-0880-46c4-b3eb-48710f86abd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/attribute-classes/clvc2w637000n494j4z3oyye3","description":"Fetches an Attribute Class by its ID
\n","urlObject":{"path":["api","v1","management","attribute-classes","clvc2w637000n494j4z3oyye3"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"dc0d0584-192f-46bb-bf33-1e61b1c1cb62","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/attribute-classes/clvc2w637000n494j4z3oyye3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 09:15:25 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clurwouax000ezffxs7unemg2\",\n \"createdAt\": \"2024-04-09T04:53:29.577Z\",\n \"updatedAt\": \"2024-04-09T04:53:29.577Z\",\n \"name\": \"email\",\n \"description\": \"The email of the person\",\n \"archived\": false,\n \"type\": \"automatic\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n }\n}"},{"id":"f49339ed-0c9b-4007-a08a-8ae05f1eadf4","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/attribute-classes/{{attributeClassId}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 09:15:37 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"internal_server_error\",\n \"message\": \"Some error occurred\",\n \"details\": {}\n}"},{"id":"8ce8412c-51b0-4238-ae4e-9d552aa739e9","name":"Not Found Error","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/attribute-classes/clvc2w637000n494j4z3oyye3s"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 09:15:59 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_found\",\n \"message\": \"Attribute Class not found\",\n \"details\": {\n \"resource_id\": \"clurwouax000ezffxs7unemg2s\",\n \"resource_type\": \"Attribute Class\"\n }\n}"}],"_postman_id":"11bdee31-0880-46c4-b3eb-48710f86abd5"},{"name":"Delete Attribute Class","id":"f55c63ad-c8ab-4b01-aed1-fecd7909a98c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/attribute-classes/clvc2w637000n494j4z3oyye3","description":"Delete an attribute class by its ID. Please note that you currently cannot delete the \"automatic\" type of attributes. Please ignore them if you do not wish to utilise them.
\n","urlObject":{"path":["api","v1","management","attribute-classes","clvc2w637000n494j4z3oyye3"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"a90a2c04-2b6e-400e-8f69-a2c7db34064e","name":"Not Found Error","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/attribute-classes/clvc2w637000n494j4z3oyye3"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 09:57:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_found\",\n \"message\": \"Attribute Class not found\",\n \"details\": {\n \"resource_id\": \"clurwouax000ezffxs7unemg2s\",\n \"resource_type\": \"Attribute Class\"\n }\n}"},{"id":"3e0d2716-004d-4cb7-97b2-fa9ea373ba8b","name":"Bad Request Error","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/attribute-classes/clvc2w637000n494j4z3oyye3"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 09:57:48 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"bad_request\",\n \"message\": \"Automatic Attribute Classes cannot be deleted\",\n \"details\": {}\n}"},{"id":"1b4b2c62-3319-4f4e-b05d-c3f45dbd1a6e","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/attribute-classes/clvc2w637000n494j4z3oyye3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 09:58:24 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clvaq78470004mhqfm0x3kasv\",\n \"createdAt\": \"2024-04-22T08:59:27.319Z\",\n \"updatedAt\": \"2024-04-22T08:59:27.319Z\",\n \"name\": \"Init Attribute 2\",\n \"description\": null,\n \"archived\": false,\n \"type\": \"code\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n }\n}"}],"_postman_id":"f55c63ad-c8ab-4b01-aed1-fecd7909a98c"},{"name":"Create Attribute Class","id":"da653be9-6d1e-4a8e-9b16-6ba74f896fa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"name\": \"My new Attribute\",\n \"type\": \"code\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/attribute-classes","description":"Create a new Attribute Class by passing in its type as well as the name! Now just use them in your app and pass this value with a user & it'll be associated with it.
\n","urlObject":{"path":["api","v1","management","attribute-classes"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"13835630-b264-4e21-826b-e5fec34ef0f6","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"name\": \"My new Attribute\",\n \"type\": \"code\",\n \"description\": \"My description\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/attribute-classes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:21:38 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clvcapx7v0000xz1zskcgf5k0\",\n \"createdAt\": \"2024-04-23T11:21:38.155Z\",\n \"updatedAt\": \"2024-04-23T11:21:38.155Z\",\n \"name\": \"My new Attribute\",\n \"description\": null,\n \"archived\": false,\n \"type\": \"code\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\"\n }\n}"},{"id":"5fadd6ea-32cf-4068-a0a7-ba93fde996e2","name":"Bad Request Error","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"name\": \"My new Attribute\",\n \"type\": \"code\",\n \"description\": \"My description\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/attribute-classes"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:22:39 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"bad_request\",\n \"message\": \"\\nInvalid `prisma.attributeClass.create()` invocation:\\n\\n\\nUnique constraint failed on the fields: (`name`,`environmentId`)\",\n \"details\": {}\n}"}],"_postman_id":"da653be9-6d1e-4a8e-9b16-6ba74f896fa8"}],"id":"31089010-d468-4a7c-943e-8ebe71b9a36e","description":"Attribute Classes help you categorize attributes so that you can target users based on specific values of their attributes. They are associated with a Person. Read more here
\n","_postman_id":"31089010-d468-4a7c-943e-8ebe71b9a36e"},{"name":"Me","item":[{"name":"Me","id":"4c7daf9b-5c2d-4eb7-9dcc-efe811b71e07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/me","description":"Fetches the product associated with the passed API key
\n","urlObject":{"path":["api","v1","management","me"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"a31bcbb4-0b7b-4fbe-8ac7-a34ae0fb413d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/me"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:31:38 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-09T04:53:29.577Z\",\n \"updatedAt\": \"2024-04-09T14:14:49.256Z\",\n \"type\": \"production\",\n \"product\": {\n \"id\": \"clurwouaj0003zffx0hu6bonm\",\n \"name\": \"My Product\"\n },\n \"widgetSetupCompleted\": true\n}"}],"_postman_id":"4c7daf9b-5c2d-4eb7-9dcc-efe811b71e07"}],"id":"79e08365-641d-4b2d-aea2-9a855e0438ec","description":"Retrieve Account Information
\n","_postman_id":"79e08365-641d-4b2d-aea2-9a855e0438ec"},{"name":"People","item":[{"name":"Get All Persons","event":[{"listen":"test","script":{"id":"933e5e71-b7dc-496f-b187-1868cee5b7da","exec":["var response = pm.response.json();","if (response.data.length > 0) {"," pm.collectionVariables.set(\"personId\", response.data[0].id);","}",""],"type":"text/javascript","packages":{}}}],"id":"02565a3f-5c02-4013-9716-600525690888","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/people","description":"Get all the identified people from Formbricks
\n","urlObject":{"path":["api","v1","management","people"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"7ad84bde-8ca0-497e-977b-0aae57f3089b","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/people"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:35:32 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"clvaq77u70002mhqfih5bnk0i\",\n \"userId\": \"THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"language\": \"gu\",\n \"Init Attribute 1\": \"eight\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-22T08:59:26.959Z\",\n \"updatedAt\": \"2024-04-22T08:59:26.959Z\"\n },\n {\n \"id\": \"clvc1tuo00003494jnz64wd0t\",\n \"userId\": \"1\",\n \"attributes\": {},\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:12:44.928Z\",\n \"updatedAt\": \"2024-04-23T07:12:44.928Z\"\n },\n {\n \"id\": \"clvc2gyay0009494jbanqhr79\",\n \"userId\": \"SECOND-USER-ID\",\n \"attributes\": {\n \"language\": \"gu\",\n \"Init Attribute 1\": \"eight\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:30:42.730Z\",\n \"updatedAt\": \"2024-04-23T07:30:42.730Z\"\n },\n {\n \"id\": \"clvc2nh5g000h494jkr6qcxhz\",\n \"userId\": \"Shubham\",\n \"attributes\": {},\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:35:47.091Z\",\n \"updatedAt\": \"2024-04-23T07:35:47.091Z\"\n },\n {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n }\n ]\n}"}],"_postman_id":"02565a3f-5c02-4013-9716-600525690888"},{"name":"Get Person by ID","id":"a7287f6d-9a5b-4d41-b5bc-ed59584ceea4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/people/clvc1tuo00003494jnz64wd0t","description":"Get a person by their internal ID on Formbricks. This internal ID can be found from the Get All Person endpoint.
\n","urlObject":{"path":["api","v1","management","people","clvc1tuo00003494jnz64wd0t"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"823409be-2aa5-4d7e-ba17-db77e5370ea0","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/people/clvc1tuo00003494jnz64wd0t"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:36:41 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clvaq77u70002mhqfih5bnk0i\",\n \"userId\": \"THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"language\": \"gu\",\n \"Init Attribute 1\": \"eight\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-22T08:59:26.959Z\",\n \"updatedAt\": \"2024-04-22T08:59:26.959Z\"\n }\n}"}],"_postman_id":"a7287f6d-9a5b-4d41-b5bc-ed59584ceea4"},{"name":"Delete Person","id":"6348b334-90ad-422d-8045-716200cfc93b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/people/clvc1tuo00003494jnz64wd0t","description":"Delete an identified person from Formbricks.
\n","urlObject":{"path":["api","v1","management","people","clvc1tuo00003494jnz64wd0t"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"ee68dcb1-894b-4224-8c4a-2d8fb19f281a","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/people/clvc1tuo00003494jnz64wd0t"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:37:27 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"success\": \"Person deleted successfully\"\n }\n}"},{"id":"513f9074-76ab-44db-b507-2d6837b060e0","name":"Not Found Error","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/people/clvc1tuo00003494jnz64wd0t"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:37:37 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_found\",\n \"message\": \"Person not found\",\n \"details\": {\n \"resource_id\": \"clvaq77u70002mhqfih5bnk0i\",\n \"resource_type\": \"Person\"\n }\n}"}],"_postman_id":"6348b334-90ad-422d-8045-716200cfc93b"}],"id":"cffc27a6-dafb-428f-8ea7-5165bedb911e","description":"Enable User Identification in Formbricks to granularly target users to show surveys to without spraying across them. This API will help you utilise Formbricks User Identification to its maximum.
\nMethods: Get All, Get, and Delete Persons
\n","_postman_id":"cffc27a6-dafb-428f-8ea7-5165bedb911e"},{"name":"Response","item":[{"name":"Get All Responses","id":"b04526df-8329-4a36-8866-9704a5e3bffe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278"}],"url":"https://app.formbricks.com/api/v1/management/responses","description":"Fetches all the responses from your environment. This is a heavy endpoint so use it wisely.
\n","urlObject":{"path":["api","v1","management","responses"],"host":["https://app.formbricks.com"],"query":[{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"skip","value":"number"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"limit","value":"number"}],"variable":[]}},"response":[{"id":"b07fd5a1-2acf-4784-a0b3-ce4947650b53","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/responses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:40:56 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"clvc3n6hy000u494jn2ypw30r\",\n \"createdAt\": \"2024-04-23T08:03:32.901Z\",\n \"updatedAt\": \"2024-04-23T08:14:12.343Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"1\": \"clicked\",\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\",\n \"hs8yd14l9h8u353tjmv6rzawqqq\": \"clicked\",\n \"tcgls012312312063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\": {\n \"url\": \"https://postman.com\",\n \"action\": \"test action\",\n \"source\": \"Postman API\",\n \"userAgent\": {}\n },\n \"ttc\": {},\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": null,\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"clvc3in3z000t494j4wtax1oi\",\n \"createdAt\": \"2024-04-23T08:00:01.151Z\",\n \"updatedAt\": \"2024-04-23T08:00:01.151Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": false,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\": {\n \"userAgent\": {}\n },\n \"ttc\": {},\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": null,\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"clvc3iebk000s494j37tq10o3\",\n \"createdAt\": \"2024-04-23T07:59:49.759Z\",\n \"updatedAt\": \"2024-04-23T07:59:49.759Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\": {\n \"userAgent\": {}\n },\n \"ttc\": {},\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": null,\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"clvc3fcm7000r494jgvs99mqa\",\n \"createdAt\": \"2024-04-23T07:57:27.583Z\",\n \"updatedAt\": \"2024-04-23T07:57:27.583Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"ho ho ho\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\": {\n \"userAgent\": {}\n },\n \"ttc\": {},\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": null,\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"clvc3eqwj000q494jali1xhzq\",\n \"createdAt\": \"2024-04-23T07:56:59.441Z\",\n \"updatedAt\": \"2024-04-23T07:56:59.441Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"hs7yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\": {\n \"userAgent\": {}\n },\n \"ttc\": {},\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": null,\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"clvc3aool000p494jzjuukfzu\",\n \"createdAt\": \"2024-04-23T07:53:49.935Z\",\n \"updatedAt\": \"2024-04-23T07:53:49.935Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\": {\n \"userAgent\": {}\n },\n \"ttc\": {},\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": null,\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"cluwq6352000klvz6t82e1oyt\",\n \"createdAt\": \"2024-04-12T13:49:47.746Z\",\n \"updatedAt\": \"2024-04-12T13:53:24.650Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"inputType\": \"text\",\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"fsef\"\n },\n \"meta\": {\n \"url\": \"http://localhost:3002/app?formbricksDebug=true\",\n \"action\": \"New Session\",\n \"userAgent\": {\n \"os\": \"Linux\",\n \"browser\": \"Chrome\"\n }\n },\n \"ttc\": {\n \"_total\": 6908,\n \"hs8yd14l9h8u353tjmv6rzaw\": 4094.60000000149,\n \"tcgls0063n8ri7dtrbnepcmz\": 2813.39999999851\n },\n \"personAttributes\": null,\n \"singleUseId\": null,\n \"language\": null,\n \"person\": null,\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"cluwoqsl4000ilvz6xmbaf5fl\",\n \"createdAt\": \"2024-04-12T13:09:54.616Z\",\n \"updatedAt\": \"2024-04-12T13:09:54.616Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": false,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\"\n },\n \"meta\": {\n \"url\": \"http://localhost:3002/app?formbricksDebug=true\",\n \"action\": \"New Session\",\n \"userAgent\": {\n \"os\": \"Linux\",\n \"browser\": \"Chrome\"\n }\n },\n \"ttc\": {},\n \"personAttributes\": null,\n \"singleUseId\": null,\n \"language\": null,\n \"person\": null,\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"cluwoq1qn000glvz6ntrzf3kc\",\n \"createdAt\": \"2024-04-12T13:09:19.823Z\",\n \"updatedAt\": \"2024-04-12T13:09:23.793Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"inputType\": \"text\",\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"aaa\"\n },\n \"meta\": {\n \"url\": \"http://localhost:3002/app?formbricksDebug=true\",\n \"action\": \"New Session\",\n \"userAgent\": {\n \"os\": \"Linux\",\n \"browser\": \"Chrome\"\n }\n },\n \"ttc\": {\n \"_total\": 4311.599999997765,\n \"hs8yd14l9h8u353tjmv6rzaw\": 2231.199999999255,\n \"tcgls0063n8ri7dtrbnepcmz\": 2080.39999999851\n },\n \"personAttributes\": null,\n \"singleUseId\": null,\n \"language\": null,\n \"person\": null,\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"cluwopkwr000dlvz6mxvueqm8\",\n \"createdAt\": \"2024-04-12T13:08:58.008Z\",\n \"updatedAt\": \"2024-04-12T13:08:58.008Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": false,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\"\n },\n \"meta\": {\n \"url\": \"http://localhost:3002/app?formbricksDebug=true\",\n \"action\": \"New Session\",\n \"userAgent\": {\n \"os\": \"Linux\",\n \"browser\": \"Chrome\"\n }\n },\n \"ttc\": {},\n \"personAttributes\": null,\n \"singleUseId\": null,\n \"language\": null,\n \"person\": null,\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"cluwon2ra000clvz6pwo3b5g3\",\n \"createdAt\": \"2024-04-12T13:07:01.174Z\",\n \"updatedAt\": \"2024-04-12T13:07:01.174Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\"\n },\n \"meta\": {\n \"url\": \"http://localhost:3002/app?formbricksDebug=true\",\n \"action\": \"New Session\",\n \"userAgent\": {\n \"os\": \"Linux\",\n \"browser\": \"Chrome\"\n }\n },\n \"ttc\": {},\n \"personAttributes\": null,\n \"singleUseId\": null,\n \"language\": null,\n \"person\": null,\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"clushut4n0002skanrv8j8309\",\n \"createdAt\": \"2024-04-09T14:45:59.927Z\",\n \"updatedAt\": \"2024-04-09T14:45:59.927Z\",\n \"surveyId\": \"clus3omb00009oo10s53e2pa5\",\n \"finished\": false,\n \"data\": {\n \"pc6xzys675f6xka3ltwof8j2\": \"It's too expensive\"\n },\n \"meta\": {\n \"url\": \"http://localhost:3000/s/clus3omb00009oo10s53e2pa5\",\n \"source\": \"\",\n \"userAgent\": {\n \"os\": \"Linux\",\n \"browser\": \"Chrome\"\n }\n },\n \"ttc\": {},\n \"personAttributes\": null,\n \"singleUseId\": null,\n \"language\": \"default\",\n \"person\": null,\n \"tags\": [],\n \"notes\": []\n }\n ]\n}"}],"_postman_id":"b04526df-8329-4a36-8866-9704a5e3bffe"},{"name":"Get Survey Responses","id":"f7e77579-edfd-4416-b266-6af2ce04dfdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278"}],"url":"https://app.formbricks.com/api/v1/management/responses?surveyId=clusgqpml0000135cxet3y8vh","description":"Pass the surveyId as a Query Parameter & only fetch responses for a specific survey that you have access to.
\n","urlObject":{"path":["api","v1","management","responses"],"host":["https://app.formbricks.com"],"query":[{"key":"surveyId","value":"clusgqpml0000135cxet3y8vh"},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"skip","value":"number"},{"disabled":true,"description":{"content":"optional (default 10)
\n","type":"text/plain"},"key":"limit","value":"number"}],"variable":[]}},"response":[{"id":"46370a86-f137-4be8-a9a9-3470a073d5ad","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":{"raw":"https://app.formbricks.com/api/v1/management/responses?surveyId=clusgqpml0000135cxet3y8vh","host":["https://app.formbricks.com"],"path":["api","v1","management","responses"],"query":[{"key":"surveyId","value":"clusgqpml0000135cxet3y8vh"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:40:24 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"clvc3n6hy000u494jn2ypw30r\",\n \"createdAt\": \"2024-04-23T08:03:32.901Z\",\n \"updatedAt\": \"2024-04-23T08:14:12.343Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"1\": \"clicked\",\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\",\n \"hs8yd14l9h8u353tjmv6rzawqqq\": \"clicked\",\n \"tcgls012312312063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\": {\n \"url\": \"https://postman.com\",\n \"action\": \"test action\",\n \"source\": \"Postman API\",\n \"userAgent\": {}\n },\n \"ttc\": {},\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": null,\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"clvc3in3z000t494j4wtax1oi\",\n \"createdAt\": \"2024-04-23T08:00:01.151Z\",\n \"updatedAt\": \"2024-04-23T08:00:01.151Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": false,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\": {\n \"userAgent\": {}\n },\n \"ttc\": {},\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": null,\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"clvc3iebk000s494j37tq10o3\",\n \"createdAt\": \"2024-04-23T07:59:49.759Z\",\n \"updatedAt\": \"2024-04-23T07:59:49.759Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\": {\n \"userAgent\": {}\n },\n \"ttc\": {},\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": null,\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"clvc3fcm7000r494jgvs99mqa\",\n \"createdAt\": \"2024-04-23T07:57:27.583Z\",\n \"updatedAt\": \"2024-04-23T07:57:27.583Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"ho ho ho\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\": {\n \"userAgent\": {}\n },\n \"ttc\": {},\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": null,\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"clvc3eqwj000q494jali1xhzq\",\n \"createdAt\": \"2024-04-23T07:56:59.441Z\",\n \"updatedAt\": \"2024-04-23T07:56:59.441Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"hs7yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\": {\n \"userAgent\": {}\n },\n \"ttc\": {},\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": null,\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"clvc3aool000p494jzjuukfzu\",\n \"createdAt\": \"2024-04-23T07:53:49.935Z\",\n \"updatedAt\": \"2024-04-23T07:53:49.935Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\": {\n \"userAgent\": {}\n },\n \"ttc\": {},\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": null,\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"cluwq6352000klvz6t82e1oyt\",\n \"createdAt\": \"2024-04-12T13:49:47.746Z\",\n \"updatedAt\": \"2024-04-12T13:53:24.650Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"inputType\": \"text\",\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"fsef\"\n },\n \"meta\": {\n \"url\": \"http://localhost:3002/app?formbricksDebug=true\",\n \"action\": \"New Session\",\n \"userAgent\": {\n \"os\": \"Linux\",\n \"browser\": \"Chrome\"\n }\n },\n \"ttc\": {\n \"_total\": 6908,\n \"hs8yd14l9h8u353tjmv6rzaw\": 4094.60000000149,\n \"tcgls0063n8ri7dtrbnepcmz\": 2813.39999999851\n },\n \"personAttributes\": null,\n \"singleUseId\": null,\n \"language\": null,\n \"person\": null,\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"cluwoqsl4000ilvz6xmbaf5fl\",\n \"createdAt\": \"2024-04-12T13:09:54.616Z\",\n \"updatedAt\": \"2024-04-12T13:09:54.616Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": false,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\"\n },\n \"meta\": {\n \"url\": \"http://localhost:3002/app?formbricksDebug=true\",\n \"action\": \"New Session\",\n \"userAgent\": {\n \"os\": \"Linux\",\n \"browser\": \"Chrome\"\n }\n },\n \"ttc\": {},\n \"personAttributes\": null,\n \"singleUseId\": null,\n \"language\": null,\n \"person\": null,\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"cluwoq1qn000glvz6ntrzf3kc\",\n \"createdAt\": \"2024-04-12T13:09:19.823Z\",\n \"updatedAt\": \"2024-04-12T13:09:23.793Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"inputType\": \"text\",\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"aaa\"\n },\n \"meta\": {\n \"url\": \"http://localhost:3002/app?formbricksDebug=true\",\n \"action\": \"New Session\",\n \"userAgent\": {\n \"os\": \"Linux\",\n \"browser\": \"Chrome\"\n }\n },\n \"ttc\": {\n \"_total\": 4311.599999997765,\n \"hs8yd14l9h8u353tjmv6rzaw\": 2231.199999999255,\n \"tcgls0063n8ri7dtrbnepcmz\": 2080.39999999851\n },\n \"personAttributes\": null,\n \"singleUseId\": null,\n \"language\": null,\n \"person\": null,\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"cluwopkwr000dlvz6mxvueqm8\",\n \"createdAt\": \"2024-04-12T13:08:58.008Z\",\n \"updatedAt\": \"2024-04-12T13:08:58.008Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": false,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\"\n },\n \"meta\": {\n \"url\": \"http://localhost:3002/app?formbricksDebug=true\",\n \"action\": \"New Session\",\n \"userAgent\": {\n \"os\": \"Linux\",\n \"browser\": \"Chrome\"\n }\n },\n \"ttc\": {},\n \"personAttributes\": null,\n \"singleUseId\": null,\n \"language\": null,\n \"person\": null,\n \"tags\": [],\n \"notes\": []\n },\n {\n \"id\": \"cluwon2ra000clvz6pwo3b5g3\",\n \"createdAt\": \"2024-04-12T13:07:01.174Z\",\n \"updatedAt\": \"2024-04-12T13:07:01.174Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\"\n },\n \"meta\": {\n \"url\": \"http://localhost:3002/app?formbricksDebug=true\",\n \"action\": \"New Session\",\n \"userAgent\": {\n \"os\": \"Linux\",\n \"browser\": \"Chrome\"\n }\n },\n \"ttc\": {},\n \"personAttributes\": null,\n \"singleUseId\": null,\n \"language\": null,\n \"person\": null,\n \"tags\": [],\n \"notes\": []\n }\n ]\n}"}],"_postman_id":"f7e77579-edfd-4416-b266-6af2ce04dfdf"},{"name":"Get Response by ID","id":"f07f0a82-7005-4c10-b18c-11143532cf61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/responses/clvc3aool000p494jzjuukfzu","description":"Fetch the entire response object based on its ID
\n","urlObject":{"path":["api","v1","management","responses","clvc3aool000p494jzjuukfzu"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"30ba444a-ec00-4472-8235-dc4ed48bcb77","name":"Unauthorized Error","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/responses/cln1f72no000eqhgup9l9yai9"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:45:38 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"unauthorized\",\n \"message\": \"You are not authorized to access this resource\",\n \"details\": {}\n}"},{"id":"4784c4f3-8292-4e5e-b2fe-9eff908efb13","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/responses/clvc3aool000p494jzjuukfzu"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:46:08 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clvc3n6hy000u494jn2ypw30r\",\n \"createdAt\": \"2024-04-23T08:03:32.901Z\",\n \"updatedAt\": \"2024-04-23T08:14:12.343Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"1\": \"clicked\",\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\",\n \"hs8yd14l9h8u353tjmv6rzawqqq\": \"clicked\",\n \"tcgls012312312063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\": {\n \"url\": \"https://postman.com\",\n \"action\": \"test action\",\n \"source\": \"Postman API\",\n \"userAgent\": {}\n },\n \"ttc\": {},\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": null,\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n }\n}"}],"_postman_id":"f07f0a82-7005-4c10-b18c-11143532cf61"},{"name":"Delete Response","id":"c32cb7d1-31e2-4719-a498-02394ba8db6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/responses/clvc3aool000p494jzjuukfzu","description":"Delete a response with its ID
\n","urlObject":{"path":["api","v1","management","responses","clvc3aool000p494jzjuukfzu"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"f0e63409-478a-4deb-a374-7dbcabdac15c","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/responses/clvc3aool000p494jzjuukfzu"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:46:40 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clvc3n6hy000u494jn2ypw30r\",\n \"createdAt\": \"2024-04-23T08:03:32.901Z\",\n \"updatedAt\": \"2024-04-23T08:14:12.343Z\",\n \"surveyId\": \"clusgqpml0000135cxet3y8vh\",\n \"finished\": true,\n \"data\": {\n \"1\": \"clicked\",\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\",\n \"hs8yd14l9h8u353tjmv6rzawqqq\": \"clicked\",\n \"tcgls012312312063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"meta\": {\n \"url\": \"https://postman.com\",\n \"action\": \"test action\",\n \"source\": \"Postman API\",\n \"userAgent\": {}\n },\n \"ttc\": {},\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": null,\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n }\n}"},{"id":"a4041117-2021-45f4-bd84-fc629182ee1e","name":"Unauthorized Error","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/responses/clvc3aool000p494jzjuukfzu"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:46:49 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"unauthorized\",\n \"message\": \"You are not authorized to access this resource\",\n \"details\": {}\n}"}],"_postman_id":"c32cb7d1-31e2-4719-a498-02394ba8db6b"},{"name":"Update Response","id":"8d5528bd-27ec-405c-af52-0a80bd349931","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzawqqq\": \"clicked\", // Question IDs & their answers\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"ttc\": { // OPTIONAL\n \"hs8yd14l9h8u353tjmv6rzawqqq\": 120,\n \"tcgls0063n8ri7dtrbnepcmz\": 190\n },\n \"language\": \"en\" // OPTIONAL\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/responses/clvc3aool000p494jzjuukfzu","description":"Update an existing user response with new data
\n","urlObject":{"path":["api","v1","management","responses","clvc3aool000p494jzjuukfzu"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"6f674db2-1292-4ee3-9155-f97112d37d10","name":"Unauthorized Error","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/responses/clvc3aool000p494jzjuukfzu"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 12:10:34 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"unauthorized\",\n \"message\": \"You are not authorized to access this resource\",\n \"details\": {}\n}"},{"id":"e70d1c41-462b-4239-857b-6fc342bb577b","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzawqqq\": \"clicked\", // Question IDs & their answers\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"ttc\": { // OPTIONAL\n \"hs8yd14l9h8u353tjmv6rzawqqq\": 120,\n \"tcgls0063n8ri7dtrbnepcmz\": 190\n },\n \"language\": \"en\" // OPTIONAL\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/responses/clvc3aool000p494jzjuukfzu"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 12:16:39 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clvccml2p0009xz1zrlk1wbqb\",\n \"createdAt\": \"2024-04-23T12:15:01.680Z\",\n \"updatedAt\": \"2024-04-23T12:16:39.774Z\",\n \"surveyId\": \"clus3omb00009oo10s53e2pa5\",\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\",\n \"hs8yd14l9h8u353tjmv6rzawqqq\": \"clicked\"\n },\n \"meta\": {\n \"url\": \"https://postman.com\",\n \"action\": \"test action\",\n \"source\": \"Postman API\",\n \"userAgent\": {}\n },\n \"ttc\": {\n \"_total\": 310,\n \"tcgls0063n8ri7dtrbnepcmz\": 190,\n \"hs8yd14l9h8u353tjmv6rzawqqq\": 120\n },\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": \"en\",\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n }\n}"}],"_postman_id":"8d5528bd-27ec-405c-af52-0a80bd349931"},{"name":"Create Response","id":"808d1495-36f4-4409-b6c1-7e6cb57e0285","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278"}],"body":{"mode":"raw","raw":"{\n \"surveyId\": \"clwj7hi7r0000vfhpfze6vjdg\",\n \"finished\": false,\n \"createdAt\": \"2024-09-05T08:44:16.051Z\",\n \"updatedAt\": \"2024-09-05T08:44:16.051Z\",\n \"data\": {\n \"hg508afs7lgx8nlni5dtit5u\": [\n \"Hello World\"\n ]\n },\n \"language\": \"default\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/responses","description":"Create a user response using the management API
\n","urlObject":{"path":["api","v1","management","responses"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"3a100fbe-bbc5-468e-9553-1af18c63bddd","name":"Unauthorized Error","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/responses/clvc3aool000p494jzjuukfzu"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 12:10:34 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"unauthorized\",\n \"message\": \"You are not authorized to access this resource\",\n \"details\": {}\n}"},{"id":"095082f6-dd9e-45b2-a2ba-737b2c5325ee","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzawqqq\": \"clicked\", // Question IDs & their answers\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n },\n \"ttc\": { // OPTIONAL\n \"hs8yd14l9h8u353tjmv6rzawqqq\": 120,\n \"tcgls0063n8ri7dtrbnepcmz\": 190\n },\n \"language\": \"en\" // OPTIONAL\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/responses/clvc3aool000p494jzjuukfzu"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 12:16:39 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clvccml2p0009xz1zrlk1wbqb\",\n \"createdAt\": \"2024-04-23T12:15:01.680Z\",\n \"updatedAt\": \"2024-04-23T12:16:39.774Z\",\n \"surveyId\": \"clus3omb00009oo10s53e2pa5\",\n \"finished\": true,\n \"data\": {\n \"hs8yd14l9h8u353tjmv6rzaw\": \"clicked\",\n \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\",\n \"hs8yd14l9h8u353tjmv6rzawqqq\": \"clicked\"\n },\n \"meta\": {\n \"url\": \"https://postman.com\",\n \"action\": \"test action\",\n \"source\": \"Postman API\",\n \"userAgent\": {}\n },\n \"ttc\": {\n \"_total\": 310,\n \"tcgls0063n8ri7dtrbnepcmz\": 190,\n \"hs8yd14l9h8u353tjmv6rzawqqq\": 120\n },\n \"personAttributes\": {\n \"Created From\": \"API\",\n \"created_from\": \"API\"\n },\n \"singleUseId\": null,\n \"language\": \"en\",\n \"person\": {\n \"id\": \"clvc2s3ig000k494jltkqkm2u\",\n \"userId\": \"THIS-IS-A-VVERY-LONG-USER-ID-FOR-TESTING\",\n \"attributes\": {\n \"created_from\": \"API\",\n \"Created From\": \"API\"\n },\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdAt\": \"2024-04-23T07:39:22.696Z\",\n \"updatedAt\": \"2024-04-23T07:39:22.696Z\"\n },\n \"tags\": [],\n \"notes\": []\n }\n}"}],"_postman_id":"808d1495-36f4-4409-b6c1-7e6cb57e0285"}],"id":"e544ec0d-8b30-4e33-8d35-2441cb40d676","description":"Responses are what your users fill in as answers to a survey. Use this cautiosly and make sure you handle this data carefully.
\nMethods allowed: Get All, Get by Survey, Get, Update, and Delete Responses
\n","_postman_id":"e544ec0d-8b30-4e33-8d35-2441cb40d676"},{"name":"Survey","item":[{"name":"Get All Surveys","id":"812bb34d-7a58-45ac-81ad-a88cec27fa1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/surveys","description":"Fetches all existing surveys
\n","urlObject":{"path":["api","v1","management","surveys"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"33370342-b359-4fc2-b3ba-3d34027376a2","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/surveys"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:48:18 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"clzgw1k4i0001mny1unf8eggn\",\n \"createdAt\": \"2024-08-05T11:08:27.042Z\",\n \"updatedAt\": \"2024-08-05T11:09:21.826Z\",\n \"name\": \"Example Survey\",\n \"type\": \"link\",\n \"environmentId\": \"clygwxsbh01v5aga1sdien2th\",\n \"createdBy\": \"clfv1zvij0000ru0gunwpy43a\",\n \"status\": \"inProgress\",\n \"welcomeCard\": {\n \"html\": {\n \"default\": \"Thanks for providing your feedback - let's go!
\"\n },\n \"enabled\": true,\n \"fileUrl\": \"\",\n \"headline\": {\n \"default\": \"Welcome!\"\n },\n \"timeToFinish\": false,\n \"showResponseCount\": false\n },\n \"questions\": [\n {\n \"id\": \"ovpy6va1hab7fl12n913zua0\",\n \"type\": \"openText\",\n \"headline\": {\n \"default\": \"What would you like to know?\"\n },\n \"required\": true,\n \"inputType\": \"text\",\n \"subheader\": {\n \"default\": \"This is an example survey.\"\n },\n \"placeholder\": {\n \"default\": \"Type your answer here...\"\n }\n },\n {\n \"id\": \"awkn2llljy7a4oulp5t15yec\",\n \"type\": \"multipleChoiceMulti\",\n \"choices\": [\n {\n \"id\": \"xpoxuu3sifk1ee8he67ctf5i\",\n \"label\": {\n \"default\": \"Sun ☀️\"\n }\n },\n {\n \"id\": \"hnsovcdmxtcbly6tig1az3qc\",\n \"label\": {\n \"default\": \"Ocean 🌊\"\n }\n },\n {\n \"id\": \"kcnelzdxknvwo8fq20d3nrr5\",\n \"label\": {\n \"default\": \"Palms 🌴\"\n }\n }\n ],\n \"headline\": {\n \"default\": \"What's important on vacay?\"\n },\n \"required\": true,\n \"shuffleOption\": \"none\"\n }\n ],\n \"endings\": [\n {\n \"id\": \"p73t62dgwq0cvmtt6ug0hmfc\",\n \"type\": \"endScreen\",\n \"headline\": {\n \"default\": \"Thank you!\"\n },\n \"subheader\": {\n \"default\": \"We appreciate your feedback.\"\n },\n \"buttonLink\": \"https://formbricks.com/signup\",\n \"buttonLabel\": {\n \"default\": \"Create your own Survey\"\n }\n }\n ],\n \"hiddenFields\": {\n \"enabled\": false,\n \"fieldIds\": []\n },\n \"displayOption\": \"displayOnce\",\n \"recontactDays\": null,\n \"displayLimit\": null,\n \"autoClose\": null,\n \"runOnDate\": null,\n \"closeOnDate\": null,\n \"delay\": 0,\n \"displayPercentage\": null,\n \"autoComplete\": null,\n \"isVerifyEmailEnabled\": false,\n \"redirectUrl\": null,\n \"productOverwrites\": null,\n \"styling\": null,\n \"surveyClosedMessage\": null,\n \"singleUse\": {\n \"enabled\": false,\n \"isEncrypted\": true\n },\n \"pin\": null,\n \"resultShareKey\": null,\n \"showLanguageSwitch\": null,\n \"languages\": [],\n \"triggers\": [],\n \"segment\": null\n }\n ]\n}\n"}],"_postman_id":"812bb34d-7a58-45ac-81ad-a88cec27fa1c"},{"name":"Get Survey by ID","id":"4d7386ce-252f-417c-b85a-b65d4ecf73bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/surveys/clusgqpml0000135cxet3y8vh","description":"Fetch a survey object based on its ID
\n","urlObject":{"path":["api","v1","management","surveys","clusgqpml0000135cxet3y8vh"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"2803338b-a913-4107-a200-adc45402f8c1","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/surveys/clusgqpml0000135cxet3y8vh"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:49:06 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clzgw1k4i0001mny1unf8eggn\",\n \"createdAt\": \"2024-08-05T11:08:27.042Z\",\n \"updatedAt\": \"2024-08-05T11:09:21.826Z\",\n \"name\": \"Example Survey\",\n \"type\": \"link\",\n \"environmentId\": \"clygwxsbh01v5aga1sdien2th\",\n \"createdBy\": \"clfv1zvij0000ru0gunwpy43a\",\n \"status\": \"inProgress\",\n \"welcomeCard\": {\n \"html\": {\n \"default\": \"Thanks for providing your feedback - let's go!
\"\n },\n \"enabled\": true,\n \"fileUrl\": \"\",\n \"headline\": {\n \"default\": \"Welcome!\"\n },\n \"timeToFinish\": false,\n \"showResponseCount\": false\n },\n \"questions\": [\n {\n \"id\": \"ovpy6va1hab7fl12n913zua0\",\n \"type\": \"openText\",\n \"headline\": {\n \"default\": \"What would you like to know?\"\n },\n \"required\": true,\n \"inputType\": \"text\",\n \"subheader\": {\n \"default\": \"This is an example survey.\"\n },\n \"placeholder\": {\n \"default\": \"Type your answer here...\"\n }\n },\n {\n \"id\": \"awkn2llljy7a4oulp5t15yec\",\n \"type\": \"multipleChoiceMulti\",\n \"choices\": [\n {\n \"id\": \"xpoxuu3sifk1ee8he67ctf5i\",\n \"label\": {\n \"default\": \"Sun ☀️\"\n }\n },\n {\n \"id\": \"hnsovcdmxtcbly6tig1az3qc\",\n \"label\": {\n \"default\": \"Ocean 🌊\"\n }\n },\n {\n \"id\": \"kcnelzdxknvwo8fq20d3nrr5\",\n \"label\": {\n \"default\": \"Palms 🌴\"\n }\n }\n ],\n \"headline\": {\n \"default\": \"What's important on vacay?\"\n },\n \"required\": true,\n \"shuffleOption\": \"none\"\n }\n ],\n \"endings\": [\n {\n \"id\": \"p73t62dgwq0cvmtt6ug0hmfc\",\n \"type\": \"endScreen\",\n \"headline\": {\n \"default\": \"Thank you!\"\n },\n \"subheader\": {\n \"default\": \"We appreciate your feedback.\"\n },\n \"buttonLink\": \"https://formbricks.com/signup\",\n \"buttonLabel\": {\n \"default\": \"Create your own Survey\"\n }\n }\n ],\n \"hiddenFields\": {\n \"enabled\": false,\n \"fieldIds\": []\n },\n \"displayOption\": \"displayOnce\",\n \"recontactDays\": null,\n \"displayLimit\": null,\n \"autoClose\": null,\n \"runOnDate\": null,\n \"closeOnDate\": null,\n \"delay\": 0,\n \"displayPercentage\": null,\n \"autoComplete\": null,\n \"isVerifyEmailEnabled\": false,\n \"redirectUrl\": null,\n \"productOverwrites\": null,\n \"styling\": null,\n \"surveyClosedMessage\": null,\n \"singleUse\": {\n \"enabled\": false,\n \"isEncrypted\": true\n },\n \"pin\": null,\n \"resultShareKey\": null,\n \"showLanguageSwitch\": null,\n \"languages\": [],\n \"triggers\": [],\n \"segment\": null\n }\n}"}],"_postman_id":"4d7386ce-252f-417c-b85a-b65d4ecf73bd"},{"name":"Delete Survey","id":"0fb280ea-62f8-4727-ba62-598222c33b1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/surveys/clusgqpml0000135cxet3y8vh","description":"Delete a Survey by its ID. Please use this only when extrememly necessary.
\n","urlObject":{"path":["api","v1","management","surveys","clusgqpml0000135cxet3y8vh"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"23a4276d-9e26-4626-ba07-4782f564b94e","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/surveys/clusgqpml0000135cxet3y8vh"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:49:26 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clzgw1k4i0001mny1unf8eggn\",\n \"createdAt\": \"2024-08-05T11:08:27.042Z\",\n \"updatedAt\": \"2024-08-05T11:09:21.826Z\",\n \"name\": \"Example Survey\",\n \"type\": \"link\",\n \"environmentId\": \"clygwxsbh01v5aga1sdien2th\",\n \"createdBy\": \"clfv1zvij0000ru0gunwpy43a\",\n \"status\": \"inProgress\",\n \"welcomeCard\": {\n \"html\": {\n \"default\": \"Thanks for providing your feedback - let's go!
\"\n },\n \"enabled\": true,\n \"fileUrl\": \"\",\n \"headline\": {\n \"default\": \"Welcome!\"\n },\n \"timeToFinish\": false,\n \"showResponseCount\": false\n },\n \"questions\": [\n {\n \"id\": \"ovpy6va1hab7fl12n913zua0\",\n \"type\": \"openText\",\n \"headline\": {\n \"default\": \"What would you like to know?\"\n },\n \"required\": true,\n \"inputType\": \"text\",\n \"subheader\": {\n \"default\": \"This is an example survey.\"\n },\n \"placeholder\": {\n \"default\": \"Type your answer here...\"\n }\n },\n {\n \"id\": \"awkn2llljy7a4oulp5t15yec\",\n \"type\": \"multipleChoiceMulti\",\n \"choices\": [\n {\n \"id\": \"xpoxuu3sifk1ee8he67ctf5i\",\n \"label\": {\n \"default\": \"Sun ☀️\"\n }\n },\n {\n \"id\": \"hnsovcdmxtcbly6tig1az3qc\",\n \"label\": {\n \"default\": \"Ocean 🌊\"\n }\n },\n {\n \"id\": \"kcnelzdxknvwo8fq20d3nrr5\",\n \"label\": {\n \"default\": \"Palms 🌴\"\n }\n }\n ],\n \"headline\": {\n \"default\": \"What's important on vacay?\"\n },\n \"required\": true,\n \"shuffleOption\": \"none\"\n }\n ],\n \"endings\": [\n {\n \"id\": \"p73t62dgwq0cvmtt6ug0hmfc\",\n \"type\": \"endScreen\",\n \"headline\": {\n \"default\": \"Thank you!\"\n },\n \"subheader\": {\n \"default\": \"We appreciate your feedback.\"\n },\n \"buttonLink\": \"https://formbricks.com/signup\",\n \"buttonLabel\": {\n \"default\": \"Create your own Survey\"\n }\n }\n ],\n \"hiddenFields\": {\n \"enabled\": false,\n \"fieldIds\": []\n },\n \"displayOption\": \"displayOnce\",\n \"recontactDays\": null,\n \"displayLimit\": null,\n \"autoClose\": null,\n \"runOnDate\": null,\n \"closeOnDate\": null,\n \"delay\": 0,\n \"displayPercentage\": null,\n \"autoComplete\": null,\n \"isVerifyEmailEnabled\": false,\n \"redirectUrl\": null,\n \"productOverwrites\": null,\n \"styling\": null,\n \"surveyClosedMessage\": null,\n \"singleUse\": {\n \"enabled\": false,\n \"isEncrypted\": true\n },\n \"pin\": null,\n \"resultShareKey\": null,\n \"showLanguageSwitch\": null,\n \"languages\": [],\n \"triggers\": [],\n \"segment\": null\n }\n}"},{"id":"099e3cdd-a47f-4331-8578-76f0a21e168d","name":"Not Found Error","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/management/surveys/clusgqpml0000135cxet3y8vh"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 11:49:33 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_found\",\n \"message\": \"Survey not found\",\n \"details\": {\n \"resource_id\": \"clusgqpml0000135cxet3y8vh\",\n \"resource_type\": \"Survey\"\n }\n}"}],"_postman_id":"0fb280ea-62f8-4727-ba62-598222c33b1d"},{"name":"Create Survey","event":[{"listen":"test","script":{"id":"676c39b6-9b19-4bf1-b04a-a7f6cb277df3","exec":["var response = pm.response.json();","pm.collectionVariables.set(\"surveyId\", response.data.id);",""],"type":"text/javascript","packages":{}}}],"id":"1171a063-5925-4a5a-99e2-f5c423722a92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Example Survey\",\n \"type\": \"link\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"createdBy\": null,\n \"status\": \"inProgress\",\n \"welcomeCard\": {\n \"html\": {\n \"default\": \"Thanks for providing your feedback - let's go!
\"\n },\n \"enabled\": true,\n \"fileUrl\": \"\",\n \"headline\": {\n \"default\": \"Welcome!\"\n },\n \"timeToFinish\": false,\n \"showResponseCount\": false\n },\n \"questions\": [\n {\n \"id\": \"ovpy6va1hab7fl12n913zua0\",\n \"type\": \"openText\",\n \"headline\": {\n \"default\": \"What would you like to know?\"\n },\n \"required\": true,\n \"inputType\": \"text\",\n \"subheader\": {\n \"default\": \"This is an example survey.\"\n },\n \"placeholder\": {\n \"default\": \"Type your answer here...\"\n }\n },\n {\n \"id\": \"awkn2llljy7a4oulp5t15yec\",\n \"type\": \"multipleChoiceMulti\",\n \"choices\": [\n {\n \"id\": \"xpoxuu3sifk1ee8he67ctf5i\",\n \"label\": {\n \"default\": \"Sun ☀️\"\n }\n },\n {\n \"id\": \"hnsovcdmxtcbly6tig1az3qc\",\n \"label\": {\n \"default\": \"Ocean 🌊\"\n }\n },\n {\n \"id\": \"kcnelzdxknvwo8fq20d3nrr5\",\n \"label\": {\n \"default\": \"Palms 🌴\"\n }\n }\n ],\n \"headline\": {\n \"default\": \"What's important on vacay?\"\n },\n \"required\": true,\n \"shuffleOption\": \"none\"\n }\n ],\n \"endings\": [\n {\n \"id\": \"p73t62dgwq0cvmtt6ug0hmfc\",\n \"type\": \"endScreen\",\n \"headline\": {\n \"default\": \"Thank you!\"\n },\n \"subheader\": {\n \"default\": \"We appreciate your feedback.\"\n },\n \"buttonLink\": \"https://formbricks.com/signup\",\n \"buttonLabel\": {\n \"default\": \"Create your own Survey\"\n }\n }\n ],\n \"hiddenFields\": {\n \"enabled\": false,\n \"fieldIds\": []\n },\n \"displayOption\": \"displayOnce\",\n \"recontactDays\": null,\n \"displayLimit\": null,\n \"autoClose\": null,\n \"runOnDate\": null,\n \"closeOnDate\": null,\n \"delay\": 0,\n \"displayPercentage\": null,\n \"autoComplete\": null,\n \"isVerifyEmailEnabled\": false,\n \"redirectUrl\": null,\n \"productOverwrites\": null,\n \"styling\": null,\n \"surveyClosedMessage\": null,\n \"singleUse\": {\n \"enabled\": false,\n \"isEncrypted\": true\n },\n \"pin\": null,\n \"resultShareKey\": null,\n \"showLanguageSwitch\": null,\n \"languages\": [],\n \"triggers\": [],\n \"segmentId\": null\n}\n","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/surveys","description":"Create a survey with granular settings, questions, their types, welcomeCard, thankYouCard, languages, etc right from this API. We'd however recommend you to do this via our Formbricks App with the UI for a better visual experience.
\n","urlObject":{"path":["api","v1","management","surveys"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"8cbef4ce-749c-4658-ab1d-7597197e2039","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"type\": \"link\",\n \"name\": \"My new Survey\",\n \"hiddenFields\": {\n \"enabled\": false\n },\n \"questions\": [\n {\n \"id\": \"gml6mgy71efgtq8np3s9je5p\",\n \"type\": \"openText\",\n \"headline\": {\n \"default\": \"What would you like to know?\"\n },\n \"subheader\": {\n \"default\": \"Wha--?\"\n },\n \"required\": false,\n \"buttonLabel\": {\n \"default\": \"Create your own Survey\"\n },\n \"logic\": [\n {\n \"condition\": \"skipped\",\n \"destination\": \"end\"\n }\n ],\n \"html\": \"We would love to understand your user experience better. Sharing your insight helps a lot!
\",\n \"buttonExternal\": false,\n \"dismissButtonLabel\": \"No, thanks.\"\n }\n ],\n \"thankYouCard\": {\n \"enabled\": true,\n \"headline\": {\n \"default\": \"Thank you!\"\n },\n \"subheader\": {\n \"default\": \"We appreciate your feedback.\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/surveys"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 12:29:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clzgw1k4i0001mny1unf8eggn\",\n \"createdAt\": \"2024-08-05T11:08:27.042Z\",\n \"updatedAt\": \"2024-08-05T11:09:21.826Z\",\n \"name\": \"Example Survey\",\n \"type\": \"link\",\n \"environmentId\": \"clygwxsbh01v5aga1sdien2th\",\n \"createdBy\": \"clfv1zvij0000ru0gunwpy43a\",\n \"status\": \"inProgress\",\n \"welcomeCard\": {\n \"html\": {\n \"default\": \"Thanks for providing your feedback - let's go!
\"\n },\n \"enabled\": true,\n \"fileUrl\": \"\",\n \"headline\": {\n \"default\": \"Welcome!\"\n },\n \"timeToFinish\": false,\n \"showResponseCount\": false\n },\n \"questions\": [\n {\n \"id\": \"ovpy6va1hab7fl12n913zua0\",\n \"type\": \"openText\",\n \"headline\": {\n \"default\": \"What would you like to know?\"\n },\n \"required\": true,\n \"inputType\": \"text\",\n \"subheader\": {\n \"default\": \"This is an example survey.\"\n },\n \"placeholder\": {\n \"default\": \"Type your answer here...\"\n }\n },\n {\n \"id\": \"awkn2llljy7a4oulp5t15yec\",\n \"type\": \"multipleChoiceMulti\",\n \"choices\": [\n {\n \"id\": \"xpoxuu3sifk1ee8he67ctf5i\",\n \"label\": {\n \"default\": \"Sun ☀️\"\n }\n },\n {\n \"id\": \"hnsovcdmxtcbly6tig1az3qc\",\n \"label\": {\n \"default\": \"Ocean 🌊\"\n }\n },\n {\n \"id\": \"kcnelzdxknvwo8fq20d3nrr5\",\n \"label\": {\n \"default\": \"Palms 🌴\"\n }\n }\n ],\n \"headline\": {\n \"default\": \"What's important on vacay?\"\n },\n \"required\": true,\n \"shuffleOption\": \"none\"\n }\n ],\n \"endings\": [\n {\n \"id\": \"p73t62dgwq0cvmtt6ug0hmfc\",\n \"type\": \"endScreen\",\n \"headline\": {\n \"default\": \"Thank you!\"\n },\n \"subheader\": {\n \"default\": \"We appreciate your feedback.\"\n },\n \"buttonLink\": \"https://formbricks.com/signup\",\n \"buttonLabel\": {\n \"default\": \"Create your own Survey\"\n }\n }\n ],\n \"hiddenFields\": {\n \"enabled\": false,\n \"fieldIds\": []\n },\n \"displayOption\": \"displayOnce\",\n \"recontactDays\": null,\n \"displayLimit\": null,\n \"autoClose\": null,\n \"runOnDate\": null,\n \"closeOnDate\": null,\n \"delay\": 0,\n \"displayPercentage\": null,\n \"autoComplete\": null,\n \"isVerifyEmailEnabled\": false,\n \"redirectUrl\": null,\n \"productOverwrites\": null,\n \"styling\": null,\n \"surveyClosedMessage\": null,\n \"singleUse\": {\n \"enabled\": false,\n \"isEncrypted\": true\n },\n \"pin\": null,\n \"resultShareKey\": null,\n \"showLanguageSwitch\": null,\n \"languages\": [],\n \"triggers\": [],\n \"segment\": null\n }\n}"},{"id":"ff9b7ecd-cb37-4368-8f71-d39cd1229e58","name":"Bad Request Error","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"type\": \"link\",\n \"name\": \"My new Survey\",\n \"hiddenFields\": {},\n \"questions\": [\n {\n \"id\": \"gml6mgy71efgtq8np3s9je5p\",\n \"type\": \"openText\",\n \"headline\": {\n \"default\": \"What would you like to know?\"\n },\n \"subheader\": {\n \"default\": \"Wha--?\"\n },\n \"required\": false,\n \"buttonLabel\": {\n \"default\": \"Create your own Survey\"\n },\n \"logic\": [\n {\n \"condition\": \"skipped\",\n \"destination\": \"end\"\n }\n ],\n \"html\": \"We would love to understand your user experience better. Sharing your insight helps a lot!
\",\n \"buttonExternal\": false,\n \"dismissButtonLabel\": \"No, thanks.\"\n }\n ],\n \"thankYouCard\": {\n \"enabled\": true,\n \"headline\": {\n \"default\": \"Thank you!\"\n },\n \"subheader\": {\n \"default\": \"We appreciate your feedback.\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/surveys"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"access-control-allow-headers","value":"Content-Type, Authorization"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"access-control-allow-origin","value":"*"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 12:29:50 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"bad_request\",\n \"message\": \"Fields are missing or incorrectly formatted\",\n \"details\": {\n \"hiddenFields.enabled\": \"Required\"\n }\n}"}],"_postman_id":"1171a063-5925-4a5a-99e2-f5c423722a92"},{"name":"Update Survey","id":"47883d6c-1f2d-454b-b963-3645151d291b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Example Survey\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/surveys/clusgqpml0000135cxet3y8vh","description":"Update an existing survey with new properties. This is also what we'd recommend you to do from the UI for a better visual feedback.
\n","urlObject":{"path":["api","v1","management","surveys","clusgqpml0000135cxet3y8vh"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"d069ed69-65c5-4dd7-bd30-1b4a402e1683","name":"Bad Request Error","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"cls79mi7j0000hq9o4dd60xsk\",\n \"name\": \"My new Survey\",\n \"type\": \"link\",\n \"environmentId\": \"cls4he42l000c104i72v0vmvt\",\n \"createdBy\": \"cls4he41t0000104iz7wuexy9\",\n \"status\": \"draft\",\n \"welcomeCard\": {\n \"enabled\": false\n },\n \"questions\": [],\n \"thankYouCard\": {\n \"enabled\": false\n },\n \"hiddenFields\": {\n \"enabled\": false\n },\n \"displayOption\": \"displayOnce\",\n \"recontactDays\": null,\n \"autoClose\": null,\n \"closeOnDate\": null,\n \"delay\": 0,\n \"displayPercentage\": null,\n \"autoComplete\": null,\n \"verifyEmail\": null,\n \"redirectUrl\": null,\n \"productOverwrites\": null,\n \"styling\": null,\n \"surveyClosedMessage\": null,\n \"singleUse\": {\n \"enabled\": false,\n \"isEncrypted\": true\n },\n \"pin\": null,\n \"resultShareKey\": null,\n \"triggers\": [],\n \"attributeFilters\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/surveys/clusgqpml0000135cxet3y8vh"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 12:30:32 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"bad_request\",\n \"message\": \"Survey with ID cls79mi7j0000hq9o4dd60xsk not found\",\n \"details\": {}\n}"},{"id":"9a48ed29-a059-41e9-9704-f7b118227b1a","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My new Survey\",\n \"type\": \"link\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"status\": \"draft\",\n \"welcomeCard\": {\n \"enabled\": false\n },\n \"questions\": [],\n \"thankYouCard\": {\n \"enabled\": false\n },\n \"hiddenFields\": {\n \"enabled\": false\n },\n \"displayOption\": \"displayOnce\",\n \"recontactDays\": null,\n \"autoClose\": null,\n \"closeOnDate\": null,\n \"delay\": 0,\n \"displayPercentage\": null,\n \"autoComplete\": null,\n \"verifyEmail\": null,\n \"redirectUrl\": null,\n \"productOverwrites\": null,\n \"styling\": null,\n \"surveyClosedMessage\": null,\n \"singleUse\": {\n \"enabled\": false,\n \"isEncrypted\": true\n },\n \"pin\": null,\n \"resultShareKey\": null,\n \"triggers\": [],\n \"attributeFilters\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/management/surveys/clusgqpml0000135cxet3y8vh"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 12:34:09 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clzgw1k4i0001mny1unf8eggn\",\n \"createdAt\": \"2024-08-05T11:08:27.042Z\",\n \"updatedAt\": \"2024-08-05T11:09:21.826Z\",\n \"name\": \"Example Survey\",\n \"type\": \"link\",\n \"environmentId\": \"clygwxsbh01v5aga1sdien2th\",\n \"createdBy\": \"clfv1zvij0000ru0gunwpy43a\",\n \"status\": \"inProgress\",\n \"welcomeCard\": {\n \"html\": {\n \"default\": \"Thanks for providing your feedback - let's go!
\"\n },\n \"enabled\": true,\n \"fileUrl\": \"\",\n \"headline\": {\n \"default\": \"Welcome!\"\n },\n \"timeToFinish\": false,\n \"showResponseCount\": false\n },\n \"questions\": [\n {\n \"id\": \"ovpy6va1hab7fl12n913zua0\",\n \"type\": \"openText\",\n \"headline\": {\n \"default\": \"What would you like to know?\"\n },\n \"required\": true,\n \"inputType\": \"text\",\n \"subheader\": {\n \"default\": \"This is an example survey.\"\n },\n \"placeholder\": {\n \"default\": \"Type your answer here...\"\n }\n },\n {\n \"id\": \"awkn2llljy7a4oulp5t15yec\",\n \"type\": \"multipleChoiceMulti\",\n \"choices\": [\n {\n \"id\": \"xpoxuu3sifk1ee8he67ctf5i\",\n \"label\": {\n \"default\": \"Sun ☀️\"\n }\n },\n {\n \"id\": \"hnsovcdmxtcbly6tig1az3qc\",\n \"label\": {\n \"default\": \"Ocean 🌊\"\n }\n },\n {\n \"id\": \"kcnelzdxknvwo8fq20d3nrr5\",\n \"label\": {\n \"default\": \"Palms 🌴\"\n }\n }\n ],\n \"headline\": {\n \"default\": \"What's important on vacay?\"\n },\n \"required\": true,\n \"shuffleOption\": \"none\"\n }\n ],\n \"endings\": [\n {\n \"id\": \"p73t62dgwq0cvmtt6ug0hmfc\",\n \"type\": \"endScreen\",\n \"headline\": {\n \"default\": \"Thank you!\"\n },\n \"subheader\": {\n \"default\": \"We appreciate your feedback.\"\n },\n \"buttonLink\": \"https://formbricks.com/signup\",\n \"buttonLabel\": {\n \"default\": \"Create your own Survey\"\n }\n }\n ],\n \"hiddenFields\": {\n \"enabled\": false,\n \"fieldIds\": []\n },\n \"displayOption\": \"displayOnce\",\n \"recontactDays\": null,\n \"displayLimit\": null,\n \"autoClose\": null,\n \"runOnDate\": null,\n \"closeOnDate\": null,\n \"delay\": 0,\n \"displayPercentage\": null,\n \"autoComplete\": null,\n \"isVerifyEmailEnabled\": false,\n \"redirectUrl\": null,\n \"productOverwrites\": null,\n \"styling\": null,\n \"surveyClosedMessage\": null,\n \"singleUse\": {\n \"enabled\": false,\n \"isEncrypted\": true\n },\n \"pin\": null,\n \"resultShareKey\": null,\n \"showLanguageSwitch\": null,\n \"languages\": [],\n \"triggers\": [],\n \"segment\": null\n }\n}"}],"_postman_id":"47883d6c-1f2d-454b-b963-3645151d291b"},{"name":"Get SingleUse Links","id":"c49ef758-a78a-4ef4-a282-262621151f08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278"}],"url":"https://app.formbricks.com/api/v1/management/surveys/clusgqpml0000135cxet3y8vh/singleUseIds","description":"Generates multiple single use survey links for a survey based on its id. Count of links can be controlled using the limit query param(min: 1, max: 5000, default: 10).
\n","urlObject":{"path":["api","v1","management","surveys","clusgqpml0000135cxet3y8vh","singleUseIds"],"host":["https://app.formbricks.com"],"query":[{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"limit","value":"number"}],"variable":[]}},"response":[{"id":"a6269da7-9e24-4ca4-9a7f-7b9070183b73","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278"}],"url":"http://localhost:3000/api/v1/management/surveys/clusgqpml0000135cxet3y8vh/singleUseIds"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Mon, 19 Aug 2024 12:55:21 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n \"https://app.formbricks.com/s/clzqym2l300015ycm88weliq0?suId=ohkj3qx6d0wdo9r3nfpm3bgj\",\n \"https://app.formbricks.com/s/clzqym2l300015ycm88weliq0?suId=ci6la2lzj63pvsp6x3eqbhff\",\n \"https://app.formbricks.com/s/clzqym2l300015ycm88weliq0?suId=ge8xc013ad5elmt144h2gpl4\",\n \"https://app.formbricks.com/s/clzqym2l300015ycm88weliq0?suId=zqh6x0judrawhasr4pmywbkb\",\n \"https://app.formbricks.com/s/clzqym2l300015ycm88weliq0?suId=mpqm14y2ub8utokxci6phr1y\",\n \"https://app.formbricks.com/s/clzqym2l300015ycm88weliq0?suId=g5ej7f8w9tc87xkvefeajoxa\",\n \"https://app.formbricks.com/s/clzqym2l300015ycm88weliq0?suId=av7swj3jlld97ejbw7lymbau\",\n \"https://app.formbricks.com/s/clzqym2l300015ycm88weliq0?suId=sub2yfok3sdsje2dddzf0l5d\",\n \"https://app.formbricks.com/s/clzqym2l300015ycm88weliq0?suId=hbiee77q8qunti3lxmtoq7w9\",\n \"https://app.formbricks.com/s/clzqym2l300015ycm88weliq0?suId=eo5kb2suapyks59j84egijso\"\n ]\n}"},{"id":"99ebeb71-d89f-49cf-a9fe-4af08192499f","name":"Bad request Error","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278"}],"url":"http://localhost:3000/api/v1/management/surveys/clusgqpml0000135cxet3y8vh/singleUseIds"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Mon, 19 Aug 2024 12:58:34 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"bad_request\",\n \"message\": \"Single use links are not enabled for this survey\",\n \"details\": {}\n}"}],"_postman_id":"c49ef758-a78a-4ef4-a282-262621151f08"}],"id":"953189b2-37b5-4429-a7bd-f4d01ceae242","description":"Surveys are the core of user data & feedback collection. We have various types of surveys to cater to you:
\nIn-App Surveys
\nWebsite Surveys
\nLink Surveys
\nCreate surveys & then trigger them as per your actions & attribute filterings that you have set to make the most of them.
\nMethods allowed: Get All, Get, Create, Update, and Delete Surveys
\n","_postman_id":"953189b2-37b5-4429-a7bd-f4d01ceae242"},{"name":"Webhook","item":[{"name":"Get All Webhooks","event":[{"listen":"test","script":{"id":"eed7ba89-029e-4b69-9f7c-6a29827964a4","exec":["var response = pm.response.json();","if (response.data.length > 0) {"," pm.collectionVariables.set(\"webhookId\", response.data[0].id);","}",""],"type":"text/javascript","packages":{}}}],"id":"7bd2a866-4f7b-4fb4-8f31-38a9e5b62517","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/webhooks","description":"Retrieve a list of all webhooks for the current environment
\n","urlObject":{"path":["api","v1","webhooks"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"0ff379be-786e-4653-94a5-1532d165f713","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 12:37:25 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"clvcdd8oe000nxz1zhz6q9z3l\",\n \"name\": null,\n \"createdAt\": \"2024-04-23T12:35:45.326Z\",\n \"updatedAt\": \"2024-04-23T12:35:45.326Z\",\n \"url\": \"https://eoy8o887lmsqmhz.m.pipedream.net\",\n \"source\": \"user\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"triggers\": [\n \"responseCreated\",\n \"responseUpdated\",\n \"responseFinished\"\n ],\n \"surveyIds\": []\n },\n {\n \"id\": \"clvcddph9000oxz1zsnjhvllw\",\n \"name\": null,\n \"createdAt\": \"2024-04-23T12:36:07.100Z\",\n \"updatedAt\": \"2024-04-23T12:36:07.100Z\",\n \"url\": \"https://eoy8o887lmsqmhz.m.pipedream.net\",\n \"source\": \"user\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"triggers\": [\n \"responseCreated\",\n \"responseUpdated\",\n \"responseFinished\"\n ],\n \"surveyIds\": []\n },\n {\n \"id\": \"clvcderln000pxz1z95jqj0qw\",\n \"name\": null,\n \"createdAt\": \"2024-04-23T12:36:56.507Z\",\n \"updatedAt\": \"2024-04-23T12:36:56.507Z\",\n \"url\": \"https://eoy8o887lmsqmhz.m.pipedream.net\",\n \"source\": \"user\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"triggers\": [\n \"responseCreated\",\n \"responseUpdated\",\n \"responseFinished\"\n ],\n \"surveyIds\": []\n }\n ]\n}"}],"_postman_id":"7bd2a866-4f7b-4fb4-8f31-38a9e5b62517"},{"name":"Get Webhook","id":"27942f9b-b52c-4345-a942-c283ec2566e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/webhooks/","description":"Get a specific webhook object based on its ID
\n","urlObject":{"path":["api","v1","webhooks",""],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"5d06147e-bc17-4f8d-bc91-395c39f7aa6c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/webhooks/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 12:38:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clvcdd8oe000nxz1zhz6q9z3l\",\n \"name\": null,\n \"createdAt\": \"2024-04-23T12:35:45.326Z\",\n \"updatedAt\": \"2024-04-23T12:35:45.326Z\",\n \"url\": \"https://eoy8o887lmsqmhz.m.pipedream.net\",\n \"source\": \"user\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"triggers\": [\n \"responseCreated\",\n \"responseUpdated\",\n \"responseFinished\"\n ],\n \"surveyIds\": []\n }\n}"}],"_postman_id":"27942f9b-b52c-4345-a942-c283ec2566e5"},{"name":"Delete Webhook","id":"1d2af723-ff32-4e37-9ca0-40cf2ed4dda1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/webhooks/","description":"Delete an existing webhook by provifding it's ID. It will immediately apply and not trigger again.
\n","urlObject":{"path":["api","v1","webhooks",""],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"2a25738d-d7d1-4a92-b68c-ee42ca845c39","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/webhooks/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 12:38:57 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clvcdd8oe000nxz1zhz6q9z3l\",\n \"name\": null,\n \"createdAt\": \"2024-04-23T12:35:45.326Z\",\n \"updatedAt\": \"2024-04-23T12:35:45.326Z\",\n \"url\": \"https://eoy8o887lmsqmhz.m.pipedream.net\",\n \"source\": \"user\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"triggers\": [\n \"responseCreated\",\n \"responseUpdated\",\n \"responseFinished\"\n ],\n \"surveyIds\": []\n }\n}"},{"id":"9fb726fd-856c-4696-a377-f116f366b419","name":"Not Found Error","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"url":"https://app.formbricks.com/api/v1/webhooks/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 12:39:22 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_found\",\n \"message\": \"Webhook not found\",\n \"details\": {\n \"resource_id\": \"clvcdd8oe000nxz1zhz6q9z3l\",\n \"resource_type\": \"Webhook\"\n }\n}"}],"_postman_id":"1d2af723-ff32-4e37-9ca0-40cf2ed4dda1"},{"name":"Create Webhook","event":[{"listen":"test","script":{"id":"6c419928-eca9-4bb8-b25c-c7e2fc04232c","exec":["var response = pm.response.json();","pm.collectionVariables.set(\"webhookId\", response.data.id);",""],"type":"text/javascript","packages":{}}}],"id":"5b3d180c-045e-44ce-8737-b5aa4ff1f646","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://eoy8o887lmsqmhz.m.pipedream.net\",\n \"triggers\": [\n \"responseCreated\",\n \"responseUpdated\",\n \"responseFinished\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/webhooks","description":"Create a new webhook right from the API and see it active right away!
\n","urlObject":{"path":["api","v1","webhooks"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"0b083bb2-faee-467d-b7d0-d756e2d8b82f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"ced9299405415cbaa83ce208a2519278","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://eoy8o887lmsqmhz.m.pipedream.net\",\n \"triggers\": [\n \"responseCreated\",\n \"responseUpdated\",\n \"responseFinished\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.formbricks.com/api/v1/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch"},{"key":"cache-control","value":"private, no-store"},{"key":"content-type","value":"application/json"},{"key":"Date","value":"Tue, 23 Apr 2024 12:35:45 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"clvcdd8oe000nxz1zhz6q9z3l\",\n \"name\": null,\n \"createdAt\": \"2024-04-23T12:35:45.326Z\",\n \"updatedAt\": \"2024-04-23T12:35:45.326Z\",\n \"url\": \"https://eoy8o887lmsqmhz.m.pipedream.net\",\n \"source\": \"user\",\n \"environmentId\": \"clurwouax000azffxt7n5unn3\",\n \"triggers\": [\n \"responseCreated\",\n \"responseUpdated\",\n \"responseFinished\"\n ],\n \"surveyIds\": []\n }\n}"}],"_postman_id":"5b3d180c-045e-44ce-8737-b5aa4ff1f646"}],"id":"62e6ec65-021b-42a4-ac93-d1434b393c6c","description":"Formbricks' Webhook API offers a powerful interface for interacting with webhooks. Webhooks allow you to receive real-time HTTP notifications of changes to specific objects in the Formbricks environment.
\nThe behavior of the webhooks is determined by their trigger settings. The trigger determines which updates the webhook sends. Current available triggers include:
\n\"responseCreated\"
\n\"responseUpdated\", and
\n\"responseFinished\".
\nThese APIs are designed to facilitate seamless integration of Formbricks with third-party systems. By making use of our webhook API, you can automate the process of sending data to these systems whenever significant events occur within your Formbricks environment.
\nMethods allowed: Get All, Get ,Create, and Delete Webhooks
\n","_postman_id":"62e6ec65-021b-42a4-ac93-d1434b393c6c"}],"id":"98fce5a1-1365-4125-8de1-acdb28206766","description":"The Management API provides access to all data and settings that are visible in the Formbricks App. This API requires a personal API Key for authentication, which can be generated in the Settings section of the Formbricks App. With the Management API, you can manage your Formbricks account programmatically, accessing and modifying data and settings as needed.
\n\n\nFor Auth: we use the
\nx-api-keyheader
API requests made to the Management API are authorized using a personal API key. This key grants the same rights and access as if you were logged in at formbricks.com. It's essential to keep your API key secure and not share it with others.
\nTo generate, store, or delete an API key, follow the instructions provided on the following page API Key.
\n","_postman_id":"98fce5a1-1365-4125-8de1-acdb28206766"},{"name":"Health Check","id":"841018f2-c2fe-4983-b95d-a77dcf667057","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.formbricks.com/health","description":"Formbricks' Health Check endpoint to make sure the App & the Database are connected with each other & up!
\n","urlObject":{"path":["health"],"host":["https://app.formbricks.com"],"query":[],"variable":[]}},"response":[{"id":"de4110ad-3e6c-40e0-b9e9-f50da838c2e2","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"https://app.formbricks.com/health"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Vary","value":"RSC, Next-Router-State-Tree, Next-Router-Prefetch, Accept-Encoding"},{"key":"Cache-Control","value":"no-store, must-revalidate"},{"key":"X-Powered-By","value":"Next.js"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Tue, 23 Apr 2024 07:03:50 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"\n\n \n \n \n \n \n \n \n \n \n \n \nAll systems are up and running
\n