This is a legacy API documentation page. Please visit this page for the latest version of Zonka Feedback APIs.
\nZonka REST APIs lets you to query and get requested data in JSON format using GET, POST, PUT or DELETE HTTP methods.This document is organized by API endpoints and examples are shown for each of the endpoints which enables you to access data from different datasets associated with your Zonka account.
\nTo access the APIs you would need a valid Auth Token. The token can be created as follows:
\nAPI tab is only accessible to Admin users within the Zonka account.The auth token will have the entire scope of the Admin user and can be used to access all datasets associated with the account.
\nThe base URL for accessing the API is
`[https://api.zonkafeedback.com/v2](https://api.zonkafeedback.com/v2](https://api.zonkafeedback.com/v2](https://api.zonkafeedback.com/v2\\)))
Following is a table representing HTTP response codes and their meaning.
\nWrite to hello@zonkafeedback.com regarding any support required while accessing the APIs. Please mention the type of request or response you require from the APIs.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"UPDATE","slug":"update"},{"content":"Authentication","slug":"authentication"},{"content":"Base URL","slug":"base-url"},{"content":"HTTP Response Codes","slug":"http-response-codes"},{"content":"Help","slug":"help"}],"owner":"2077940","collectionId":"86922977-ae32-5e11-02b6-5b1c4b91a018","publishedId":"RW1hhw84","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-04-17T10:19:23.000Z"},"item":[{"name":"Devices","item":[{"name":"Get Device Details","id":"2a2795cb-085a-f2ae-48cf-85a4f0260469","request":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"{{Z-API-TOKEN}}","description":"Your Zonka Auth token goes here
\n"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v2/devices/{{deviceId}}","description":"Get details of one or more devices associated with by passing the Device Id(s) as query parameters.
\n\n\n","urlObject":{"protocol":"https","path":["v2","devices","{{deviceId}}"],"host":["api","zonkafeedback","com"],"query":[],"variable":[]}},"response":[{"id":"efeef922-63de-42cc-a723-0ad3879294bc","name":"Get Device Details","originalRequest":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"{{Z-API-TOKEN}}","description":"Your Zonka Auth token goes here"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v2/devices/{{deviceId}}"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"200\",\n \"response\": {\n \"deviceId\": \"1530\",\n \"deviceStatus\": \"active\",\n \"deviceTags\": \"reception, customer\",\n \"deviceUid\": \"70ae4f91d10288b1\",\n \"deviceName\": \"SM-T231\",\n \"deviceFriendlyName\": \"Reception Device\",\n \"deviceDescription\": \"Device at the Reception\",\n \"deviceOS\": \"Android\",\n \"deviceOsVersion\": \"4.4.2\",\n \"deviceModel\": \"SM-T231\",\n \"deviceBrand\": \"samsung\",\n \"deviceType\": \"Android\",\n \"deviceLocationAddress\": \"\",\n \"locationId\": \"21\",\n \"deviceAppVersion\": \"3.8.3\",\n \"deviceTimeZone\": \"Asia/Calcutta\",\n \"deviceIPAddress\": \"203.92.32.10\",\n \"lastActiveOn\": \"2018-02-21 12:21:01\",\n \"lastLogIn\": \"2018-02-21 12:01:01\",\n \"lastLoggedStaffName\": \"Sonika\",\n \"surveyId\": \"3456\",\n \"surveyName\": \"New Customer Survey\",\n \"deviceLastSynced\": \"2018-02-21 12:34:19\",\n \"responseCount\": 37,\n \"totalUptime\": \"0 Hours 45 Minutes \"\n }\n}"}],"_postman_id":"2a2795cb-085a-f2ae-48cf-85a4f0260469"},{"name":"Get Devices","id":"4eeedbd3-3627-c8f0-f71c-0959dc63f0f5","request":{"method":"GET","header":[{"key":"Z-API-Token","value":"{{Z-API-TOKEN}}","description":"By default the details of the devices such as uptime and responseCount are based on totals on the device since being added to the account.
\n
Your Zonka auth token goes here
\n"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v2/devices","description":"Get list of devices associated with your Zonka Account. You can use query paramters to filter the devices as desired.
\nPARAMS
\n\n\n","urlObject":{"protocol":"https","path":["v2","devices"],"host":["api","zonkafeedback","com"],"query":[{"disabled":true,"description":{"content":"By default the details of the devices such as uptime and responseCount are total responses collected on the device since being added to the account.
\n
Fetch list based on device status. Selct from 'active' or 'deactive'
\n","type":"text/plain"},"key":"deviceStatus","value":"string"},{"disabled":true,"description":{"content":"Fetch list based on device tags assigned to the devices
\n","type":"text/plain"},"key":"deviceTags","value":"string"},{"disabled":true,"description":{"content":"Fecth list based on App status. Select from 'online', 'offline'and 'dashboard'
\n","type":"text/plain"},"key":"lastKnownAppStatus","value":"string"},{"disabled":true,"description":{"content":"Fetch list based on 'locationId'
\n","type":"text/plain"},"key":"locationId","value":"string"},{"disabled":true,"description":{"content":"Specify the number of devices records to fetch per page. 25 records per page is default.
\n","type":"text/plain"},"key":"limit","value":"string"},{"disabled":true,"description":{"content":"Specify the page number of the device list
\n","type":"text/plain"},"key":"page","value":"string"}],"variable":[]}},"response":[{"id":"c7dd5cfa-d019-4be6-a5c8-8b007910eba4","name":"Get Devices","originalRequest":{"method":"GET","header":[{"key":"Z-API-Token","value":"{{Z-API-TOKEN}}","description":"Your Zonka auth token goes here"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.zonkafeedback.com/v2/devices","protocol":"https","host":["api","zonkafeedback","com"],"path":["v2","devices"],"query":[{"key":"deviceStatus","value":"string","description":"Fetch list based on device status. Selct from 'active' or 'deactive'","disabled":true},{"key":"deviceTags","value":"string","description":"Fetch list based on device tags assigned to the devices","disabled":true},{"key":"lastKnownAppStatus","value":"string","description":"Fecth list based on App status. Select from 'online', 'offline'and 'dashboard'","disabled":true},{"key":"locationId","value":"string","description":"Fetch list based on 'locationId'","disabled":true},{"key":"limit","value":"string","description":"Specify the number of devices records to fetch per page. 25 records per page is default.","disabled":true},{"key":"page","value":"string","description":"Specify the page number of the device list","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"200\",\n \"response\": {\n \"totalRecords\": 2,\n \"currentRecords\": 2,\n \"allocatedDevices\": 5,\n \"activeDevices\": 2,\n \"dataList\": [\n {\n \"deviceId\": \"1\",\n \"deviceStatus\": \"active\",\n \"deviceFriendlyName\": \"Reception Device\",\n \"deviceOS\": \"Android\",\n \"deviceModel\": \"GT-I9500\",\n \"locationId\": \"129\",\n \"lastKnownAppStatus\": \"offline\",\n \"deviceTags\": \"Reception, Customer\"\n },\n {\n \"deviceId\": \"2\",\n \"deviceStatus\": \"active\",\n \"deviceFriendlyName\": \"Washroom Device\",\n \"deviceOS\": \"iOS\",\n \"deviceModel\": \"iPad\",\n \"locationId\": \"560\",\n \"lastKnownAppStatus\": \"dashboard\",\n \"deviceTags\": \"Washroom, Customer\"\n }\n ]\n }\n}"}],"_postman_id":"4eeedbd3-3627-c8f0-f71c-0959dc63f0f5"}],"id":"3dc61a15-e524-5c87-8b75-e5c25b74cdbc","description":"This API enables you get list of devices and device details associated with your Zonka account.
\n","_postman_id":"3dc61a15-e524-5c87-8b75-e5c25b74cdbc"},{"name":"Locations","item":[{"name":"Get Locations","id":"c1ead63e-3fee-01d5-d4ee-04f30e86178f","request":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"{{Z-API-TOKEN}}","description":"Your Zonka auth token goes here
\n"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v2/locations","description":"Get list of locations associated with your Zonka Account. You can use query paramters to filter the locations as desired.
\nPARAMS
\n","urlObject":{"protocol":"https","path":["v2","locations"],"host":["api","zonkafeedback","com"],"query":[{"disabled":true,"description":{"content":"ID of the group of which the locations are to be fetched
\n","type":"text/plain"},"key":"groupId","value":"string"},{"disabled":true,"description":{"content":"Status of the locations to be fetched. Select from 'active'or 'deactive'
\n","type":"text/plain"},"key":"locationStatus","value":"string"},{"disabled":true,"description":{"content":"Get list of location based on one or more location tags which are assigned to the location
\n","type":"text/plain"},"key":"locationTag","value":"string"}],"variable":[]}},"response":[{"id":"d07384a1-0ae7-4934-4c21-bc539e853c9d","name":"Get Location List","originalRequest":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"Your Zonka auth token goes here","description":"Your Zonka auth token goes here"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.zonkafeedback.com/v1/locations","protocol":"https","host":["api","zonkafeedback","com"],"path":["v1","locations"],"query":[{"key":"groupId","value":"string","description":"ID of the group of which the locations are to be fetched","disabled":true},{"key":"locationStatus","value":"string","description":"Status of the locations to be fetched. Select from ACTIVE or DEACTIVE","disabled":true},{"key":"staffId","value":"string","description":"Get list of location based on ID of the staff member (manager) of the locations","disabled":true},{"key":"locationTag","value":"string","description":"Get list of location based on one or more location tags which are assigned to the location ","disabled":true},{"key":"limit","value":"string","description":"Specify the number of location records to fetch per page. 10 records per page is default.","disabled":true},{"key":"page","value":"string","description":"Page number of location list ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","description":""},{"name":"Connection","key":"Connection","value":"Keep-Alive","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json; charset=utf-8","description":""},{"name":"Date","key":"Date","value":"Sat, 17 Jun 2017 05:43:03 GMT","description":""},{"name":"Expires","key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":""},{"name":"Keep-Alive","key":"Keep-Alive","value":"timeout=5, max=100","description":""},{"name":"Server","key":"Server","value":"Apache/2.4.25 (Amazon) OpenSSL/1.0.1k-fips PHP/5.4.45","description":""},{"name":"Transfer-Encoding","key":"Transfer-Encoding","value":"chunked","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"PHP/5.4.45","description":""}],"cookie":[],"responseTime":"1096","body":"{\n \"status\": \"200\",\n \"response\": {\n \"totalRecords\": 2,\n \"dataList\": [\n {\n \"locationId\": \"95\",\n \"locationName\": \"Reception\",\n \"locationStatus\": \"active\",\n \"responseCount\": \"450\",\n \"activeSurveyCount\": \"31\",\n \"userCount\": \"8\"\n },\n {\n \"locationId\": \"112\",\n \"locationName\": \"Washroom\",\n \"locationStatus\": \"active\",\n \"responseCount\": \"47\",\n \"activeSurveyCount\": \"4\",\n \"userCount\": \"2\"\n \n }\n ]\n }\n}"}],"_postman_id":"c1ead63e-3fee-01d5-d4ee-04f30e86178f"},{"name":"Get Location Details","id":"b208bcbe-cbc3-48bf-6935-9cf4e0a54ec2","request":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"{{Z-API-TOKEN}}","description":"Your Zonka Auth token goes here
\n"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v2/locations/{{locationId}}","description":"Get details of one or more locations by passing the locationId as path parameter.
\n","urlObject":{"protocol":"https","path":["v2","locations","{{locationId}}"],"host":["api","zonkafeedback","com"],"query":[],"variable":[]}},"response":[{"id":"6717b39e-a412-95d3-6713-790e8eeb2436","name":"Get Location Details","originalRequest":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"Your Zonka auth token goes here","description":"Your Zonka Auth token goes here"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v1/locations/95"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","description":""},{"name":"Connection","key":"Connection","value":"Keep-Alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"250","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json; charset=utf-8","description":""},{"name":"Date","key":"Date","value":"Sat, 17 Jun 2017 05:44:16 GMT","description":""},{"name":"Expires","key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":""},{"name":"Keep-Alive","key":"Keep-Alive","value":"timeout=5, max=100","description":""},{"name":"Server","key":"Server","value":"Apache/2.4.25 (Amazon) OpenSSL/1.0.1k-fips PHP/5.4.45","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"PHP/5.4.45","description":""}],"cookie":[],"responseTime":"1046","body":"{\n \"status\": \"200\",\n \"response\": {\n \"locationId\": \"95\",\n \"locationName\": \"Reception\",\n \"locationAddress\": \"New Jersey\",\n \"locationStatus\": \"active\",\n \"groupId\": \"36\",\n \"groupName\": \"Restaurants\",\n \"responseCount\": \"450\",\n \"activeSurveyCount\": \"31\",\n \"userCount\": \"8\"\n }\n}"}],"_postman_id":"b208bcbe-cbc3-48bf-6935-9cf4e0a54ec2"},{"name":"Get Groups","id":"03b5e455-4ac6-6a04-96b2-67da3ad34780","request":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"{{Z-API-TOKEN}}","description":"Your Zonka Auth token goes here
\n"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v2/groups","description":"Get list of groups associated with your Zonka Account.
\n","urlObject":{"protocol":"https","path":["v2","groups"],"host":["api","zonkafeedback","com"],"query":[],"variable":[]}},"response":[{"id":"4527e0f1-5590-d64d-ad82-33cfefd74be7","name":"Get Groups","originalRequest":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"Your Zonka auth token goes here","description":"Your Zonka Auth token goes here"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v1/groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","description":""},{"name":"Connection","key":"Connection","value":"Keep-Alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"4070","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json; charset=utf-8","description":""},{"name":"Date","key":"Date","value":"Mon, 19 Jun 2017 04:47:45 GMT","description":""},{"name":"Expires","key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":""},{"name":"Keep-Alive","key":"Keep-Alive","value":"timeout=5, max=100","description":""},{"name":"Server","key":"Server","value":"Apache/2.4.25 (Amazon) OpenSSL/1.0.1k-fips PHP/5.4.45","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"PHP/5.4.45","description":""}],"cookie":[],"responseTime":"3795","body":"{\n \"status\": \"200\",\n \"response\": {\n \"totalRecords\": 2,\n \"dataList\": [\n {\n \"groupId\": \"35\",\n \"groupName\": \"Cafes\",\n \"locations\": [\n {\n \"locationId\": \"986\",\n \"locationName\": \"Fenix\",\n \"locationStatus\": \"active\"\n },\n {\n \"locationId\": \"1015\",\n \"locationName\": \"The Treehouse\",\n \"locationStatus\": \"active\"\n }\n \n ]\n },\n {\n \"groupId\": \"36\",\n \"groupName\": \"Restaurants\",\n \"locations\": [\n {\n \"locationId\": \"95\",\n \"locationName\": \"Pizzeria\",\n \"locationStatus\": \"active\"\n },\n {\n \"locationId\": \"117\",\n \"locationName\": \"Roll King\",\n \"locationStatus\": \"active\"\n },\n {\n \"locationId\": \"118\",\n \"locationName\": \"The Coffee Shop\",\n \"locationStatus\": \"active\"\n }\n\n ]\n }\n ]\n }\n}"}],"_postman_id":"03b5e455-4ac6-6a04-96b2-67da3ad34780"}],"id":"5e368221-6b28-047b-de5f-df9becf5f93a","description":"This API enables you get list of locations and location details associated with your Zonka account.
\n","_postman_id":"5e368221-6b28-047b-de5f-df9becf5f93a"},{"name":"Responses","item":[{"name":"Export Responses","id":"154ed920-3d7c-07dc-cecb-cc2a808b640a","request":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"{{Z-API-TOKEN}}","description":"Your Zonka Auth token goes here
\n"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v2/export-responses","description":"This API enabbles you to downlaod your responses in either raw or actual values in CSV format. Please pass survyeId, startDate, endDate and answerType as query parameters to get CSV export Link. Max records per CSV download is 500.
\nPARAMS
\n","urlObject":{"protocol":"https","path":["v2","export-responses"],"host":["api","zonkafeedback","com"],"query":[{"disabled":true,"description":{"content":"ID of the survey to get responses for
\n","type":"text/plain"},"key":"surveyId","value":"string"},{"disabled":true,"description":{"content":"Date from which responses are to be fetched
\n","type":"text/plain"},"key":"startDate","value":"YYYY-MM-DD"},{"disabled":true,"description":{"content":"Date till which responeses are to be fetched
\n","type":"text/plain"},"key":"endDate","value":"YYYY-MM-DD"},{"disabled":true,"description":{"content":"Type of response data to be fetched. Select from ACTUAL and RAW values
\n","type":"text/plain"},"key":"answerType","value":"string"},{"disabled":true,"description":{"content":"ID of the location to get responses for
\n","type":"text/plain"},"key":"locationId","value":"string"},{"disabled":true,"description":{"content":"Specify the number of responses to be fetched. By default it will be 25. Maximum of 500 records can be fetched per request.
\n","type":"text/plain"},"key":"limit","value":"string"}],"variable":[]}},"response":[{"id":"f7dcff6a-f361-9df7-febd-e34c1e09ecdc","name":"Export Response as CSV","originalRequest":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"Your Zonka auth token goes here","description":"Your Zonka Auth token goes here"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.zonkafeedback.com/v1/export-responses","protocol":"https","host":["api","zonkafeedback","com"],"path":["v1","export-responses"],"query":[{"key":"surveyId","value":"4514","disabled":true},{"key":"startDate","value":"2017-05-01","disabled":true},{"key":"endDate","value":"2017-05-31","disabled":true},{"key":"answerType","value":"actual","disabled":true},{"key":"locationId","value":"string","description":"ID of the location to get responses for","disabled":true},{"key":"limit","value":"string","description":"Specify the number of responses to be fetched. By default it will be 25. Maximum of 500 records can be fetched per request.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","description":""},{"name":"Connection","key":"Connection","value":"Keep-Alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"132","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json; charset=utf-8","description":""},{"name":"Date","key":"Date","value":"Sat, 17 Jun 2017 07:26:23 GMT","description":""},{"name":"Expires","key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":""},{"name":"Keep-Alive","key":"Keep-Alive","value":"timeout=5, max=100","description":""},{"name":"Server","key":"Server","value":"Apache/2.4.25 (Amazon) OpenSSL/1.0.1k-fips PHP/5.4.45","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"PHP/5.4.45","description":""}],"cookie":[],"responseTime":"1087","body":"{\"status\":\"200\",\"response\":{\"dowloadUrl\":\"https:\\/\\/app.zonkafeedback.com\\/ExportItem\\/Excel\\/Feedback_Export_149768438348077.xls\"}}"}],"_postman_id":"154ed920-3d7c-07dc-cecb-cc2a808b640a"},{"name":"Get Response Details","id":"aa724340-b7cc-c77f-a42f-b6fed1b65ffb","request":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"{{Z-API-TOKEN}}","description":"Your Zonka Auth token goes here
\n"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v2/responses/{{responseId}}","description":"Get details of one or more responses by passing the responseId as path parameter.
\n","urlObject":{"protocol":"https","path":["v2","responses","{{responseId}}"],"host":["api","zonkafeedback","com"],"query":[],"variable":[]}},"response":[{"id":"d721cafa-827b-803a-54cf-29e632076a52","name":"Get Response Details","originalRequest":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"Your Zonka auth token goes here","description":"Your Zonka Auth token goes here"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v1/responses/251710"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","description":""},{"name":"Connection","key":"Connection","value":"Keep-Alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1518","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json; charset=utf-8","description":""},{"name":"Date","key":"Date","value":"Sat, 17 Jun 2017 05:54:42 GMT","description":""},{"name":"Expires","key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":""},{"name":"Keep-Alive","key":"Keep-Alive","value":"timeout=5, max=100","description":""},{"name":"Server","key":"Server","value":"Apache/2.4.25 (Amazon) OpenSSL/1.0.1k-fips PHP/5.4.45","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"PHP/5.4.45","description":""}],"cookie":[],"responseTime":"761","body":"{\n \"status\": \"200\",\n \"response\": {\n \"responseId\": \"282474\",\n \"surveyId\": \"5228\",\n \"surveyName\": \"Customer Survey\",\n \"surveyLanguage\": \"en_US\",\n \"recievedDate\": \"2018-04-16 16:13:34\",\n \"locationId\": \"\",\n \"locationName\": \"Chicago\",\n \"respondentId\": \"338884\",\n \"userId\": \"239\",\n \"userName\": \"Adam Newton\",\n \"deviceName\": \"Reception Device\",\n \"defaultTags\": \"Negative\",\n \"customTags\": \"Concern\",\n \"rating\": \"4.17\",\n \"NPS\": \"6\",\n \"CES\": \"2\",\n \"responseDetails\": [\n {\n \"questionId\": \"65035\",\n \"questionLabel\": \"What have you purchased today?\",\n \"answer\": \"Books\",\n \"choiceId\": \"1234\",\n \"optionId\": \"\"\n },\n {\n \"questionId\": \"65038\",\n \"questionLabel\": \"What kind of books do you like?\",\n \"answer\": \"Fiction,SciFi\",\n \"choiceId\": \"163303,163302\",\n \"optionId\": \"\"\n },\n {\n \"questionId\": \"65039\",\n \"questionLabel\": \"How likely are you to recommend us to your family and friends?\",\n \"answer\": \"9\",\n \"choiceId\": \"163305\",\n \"optionId\": \"\"\n }\n \n ]\n }\n}"}],"_postman_id":"aa724340-b7cc-c77f-a42f-b6fed1b65ffb"},{"name":"Get Responses","id":"1e9ce88a-7349-4f86-9cfe-81fe7be24d06","request":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"{{Z-API-TOKEN}}","description":"Your Zonka Auth token goes here
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v2/responses","description":"This API will enable you to get list of all responses related to a company account. The list will include details of each of the responses.
\n","urlObject":{"protocol":"https","path":["v2","responses"],"host":["api","zonkafeedback","com"],"query":[{"disabled":true,"description":{"content":"ID of the survey to get responses for
\n","type":"text/plain"},"key":"surveyId","value":"string"},{"disabled":true,"description":{"content":"ID of the survey to get responses for
\n","type":"text/plain"},"key":"locationId","value":"string"},{"disabled":true,"description":{"content":"Date from which responses are to be fetched
\n","type":"text/plain"},"key":"startDate","value":"YYYY-MM-DD"},{"disabled":true,"description":{"content":"Date till which responeses are to be fetched
\n","type":"text/plain"},"key":"endDate","value":"YYYY-MM-DD"},{"disabled":true,"description":{"content":"Type of Respondent for which responses are to be fetched. Select from ALL, NEW or REPEAT
\n","type":"text/plain"},"key":"respondentType","value":"string"},{"disabled":true,"description":{"content":"Fetch responses filtered as comments
\n","type":"text/plain"},"key":"comments","value":"string"},{"disabled":true,"description":{"content":"Fetch responses filtered as todo
\n","type":"text/plain"},"key":"todo","value":"string"},{"disabled":true,"description":{"content":"Fetch responses filtered as urgent
\n","type":"text/plain"},"key":"urgent","value":"string"},{"disabled":true,"description":{"content":"Fetch responses filtered as flagged
\n","type":"text/plain"},"key":"flagged","value":"string"},{"disabled":true,"description":{"content":"Fetch responses filtered as notes
\n","type":"text/plain"},"key":"notes","value":"string"},{"disabled":true,"description":{"content":"Fetch responses by default tags. Select from POSITIVE, NEGATIVE and NEUTRAL
\n","type":"text/plain"},"key":"defaultTags","value":"string"},{"disabled":true,"description":{"content":"Fetch responses by custom defined tags.
\n","type":"text/plain"},"key":"customTags","value":"string"},{"disabled":true,"description":{"content":"Fetch responses by particular page number. 25 responses are fetched per page.
\n","type":"text/plain"},"key":"page","value":"string"},{"disabled":true,"description":{"content":"Specify the number of responses to fetch per page. 25 responses per page is default.
\n","type":"text/plain"},"key":"limit","value":"string"},{"disabled":true,"description":{"content":"Fetch list of responses by the User ID who took the responses
\n","type":"text/plain"},"key":"userId","value":"string"},{"disabled":true,"description":{"content":"Fetch list of responses by the Respondent ID who submitted the responses
\n","type":"text/plain"},"key":"respondentId","value":"string"},{"disabled":true,"description":{"content":"Fetch list by response read status. Select from ALL, READ and UNREAD
\n","type":"text/plain"},"key":"responseStatus","value":"string"},{"disabled":true,"description":{"content":"Fetch list of responses recieved via web. Select from 1 or 0
\n","type":"text/plain"},"key":"online","value":"string"},{"disabled":true,"description":{"content":"Fetch list of responses recieved via SMS. Select from 1 or 0
\n","type":"text/plain"},"key":"sms","value":"string"},{"disabled":true,"description":{"content":"Fetch list of responses recieved via Email. Select from 1 or 0
\n","type":"text/plain"},"key":"email","value":"string"},{"disabled":true,"description":{"content":"Fetch list of responses recieved via Device. Select from 1 or 0
\n","type":"text/plain"},"key":"device","value":"string"}],"variable":[]}},"response":[{"id":"61dfe76b-b368-deea-8b22-33b0a112652f","name":"Get Responses List","originalRequest":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"Your Zonka auth token goes here","description":"Your Zonka Auth token goes here"},{"key":"","value":"","warning":"","disabled":true}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.zonkafeedback.com/v1/responses","protocol":"https","host":["api","zonkafeedback","com"],"path":["v1","responses"],"query":[{"key":"surveyId","value":"string","description":"ID of the survey to get responses for ","disabled":true},{"key":"locationId","value":"string","description":"ID of the survey to get responses for ","disabled":true},{"key":"startDate","value":"YYYY-MM-DD","description":"Date from which responses are to be fetched ","disabled":true},{"key":"endDate","value":"YYYY-MM-DD","description":"Date till which responeses are to be fetched","disabled":true},{"key":"respondentType","value":"string","description":"Type of Respondent for which responses are to be fetched. Select from ALL, NEW or REPEAT","disabled":true},{"key":"comments","value":"string","description":"Fetch responses filtered as comments","disabled":true},{"key":"todo","value":"string","description":"Fetch responses filtered as todo","disabled":true},{"key":"urgent","value":"string","description":"Fetch responses filtered as urgent","disabled":true},{"key":"flagged","value":"string","description":"Fetch responses filtered as flagged","disabled":true},{"key":"notes","value":"string","description":"Fetch responses filtered as notes","disabled":true},{"key":"defaultTags","value":"string","description":"Fetch responses by default tags. Select from POSITIVE, NEGATIVE and NEUTRAL","disabled":true},{"key":"customTags","value":"string","description":"Fetch responses by custom defined tags.","disabled":true},{"key":"page","value":"string","description":"Fetch responses by particular page number. 25 responses are fetched per page.","disabled":true},{"key":"limit","value":"string","description":"Specify the number of responses to fetch per page. 25 responses per page is default.","disabled":true},{"key":"userId","value":"string","description":"Fetch list of responses by the Staff ID who took the responses","disabled":true},{"key":"respondentId","value":"string","description":"Fetch list of responses by the Respondent ID who submitted the responses","disabled":true},{"key":"responseStatus","value":"string","description":"Fetch list by response read status. Select from ALL, READ and UNREAD","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","description":""},{"name":"Connection","key":"Connection","value":"Keep-Alive","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json; charset=utf-8","description":""},{"name":"Date","key":"Date","value":"Sat, 17 Jun 2017 05:51:10 GMT","description":""},{"name":"Expires","key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":""},{"name":"Keep-Alive","key":"Keep-Alive","value":"timeout=5, max=100","description":""},{"name":"Server","key":"Server","value":"Apache/2.4.25 (Amazon) OpenSSL/1.0.1k-fips PHP/5.4.45","description":""},{"name":"Transfer-Encoding","key":"Transfer-Encoding","value":"chunked","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"PHP/5.4.45","description":""}],"cookie":[],"responseTime":"4805","body":"{\n \"status\": \"200\",\n \"response\": {\n \"totalRecords\": 2,\n \"currentRecords\": 2,\n \"dataList\": [\n {\n \"responseId\": \"282474\",\n \"surveyId\": \"5228\",\n \"surveyName\": \"Customer Survey\",\n \"surveyLanguage\": \"en_US\",\n \"recievedDate\": \"2018-04-16 16:13:34\",\n \"locationId\": \"3491\",\n \"locationName\": \"Chicago\",\n \"respondentId\": \"338884\",\n \"userId\": \"239\",\n \"userName\": \"Adam Newton\",\n \"deviceName\": \"Reception Device\",\n \"defaultTags\": \"Negative\",\n \"customTags\": \"Concern\",\n \"rating\": \"4.17\",\n \"NPS\": \"6\",\n \"CES\": \"2\",\n \"responseDetails\": [\n {\n \"questionId\": \"65035\",\n \"questionLabel\": \"What have you purchased today?\",\n \"answer\": \"Books\",\n \"choiceId\": \"1234\",\n \"optionId\": \"\"\n },\n {\n \"questionId\": \"65038\",\n \"questionLabel\": \"What kind of books do you like?\",\n \"answer\": \"Fiction,SciFi\",\n \"choiceId\": \"163303,163302\",\n \"optionId\": \"\"\n },\n {\n \"questionId\": \"65039\",\n \"questionLabel\": \"How likely are you to recommend us to your family and friends?\",\n \"answer\": \"6\",\n \"choiceId\": \"163305\",\n \"optionId\": \"\"\n } \n ]\n },\n {\n \"responseId\": \"282473\",\n \"surveyId\": \"5228\",\n \"surveyName\": \"Customer Survey\",\n \"surveyLanguage\": \"en_US\",\n \"recievedDate\": \"2018-04-16 15:40:27\",\n \"locationId\": \"3491\",\n \"locationName\": \"Chicago\",\n \"respondentId\": \"338883\",\n \"userId\": \"239\",\n \"userName\": \"Adam Newton\",\n \"deviceName\": \"Reception Device\",\n \"defaultTags\": \"Positve\",\n \"customTags\": \"Good\",\n \"rating\": \"8\",\n \"NPS\": \"9\",\n \"CES\": \"1\",\n \"responseDetails\": [\n {\n \"questionId\": \"65035\",\n \"questionLabel\": \"What have you purchased today?\",\n \"answer\": \"Books\",\n \"choiceId\": \"1234\",\n \"optionId\": \"\"\n },\n {\n \"questionId\": \"65038\",\n \"questionLabel\": \"What kind of books do you like?\",\n \"answer\": \"Fiction,SciFi\",\n \"choiceId\": \"163303,163302\",\n \"optionId\": \"\"\n },\n {\n \"questionId\": \"65039\",\n \"questionLabel\": \"How likely are you to recommend us to your family and friends?\",\n \"answer\": \"9\",\n \"choiceId\": \"163305\",\n \"optionId\": \"\"\n } \n ]\n }\n ]\n }\n}"}],"_postman_id":"1e9ce88a-7349-4f86-9cfe-81fe7be24d06"}],"id":"fe21e490-85d5-d6e9-449f-2ad9e6f880b9","description":"Get Response list and Response Details associated with your Zonka Account.
\n","_postman_id":"fe21e490-85d5-d6e9-449f-2ad9e6f880b9"},{"name":"Surveys","item":[{"name":"Get Surveys","id":"5c003adb-20b4-fe9c-5bb4-348572cc16c8","request":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"{{Z-API-TOKEN}}","description":"Your Zonka Auth token goes here
\n"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v2/surveys","description":"Get list of surveys associated with your Zonka account.
\nPARAMS
\n","urlObject":{"protocol":"https","path":["v2","surveys"],"host":["api","zonkafeedback","com"],"query":[{"disabled":true,"description":{"content":"Get list of surveys based on the location ID
\n","type":"text/plain"},"key":"locationId","value":"string"},{"disabled":true,"description":{"content":"Get list of surveys based on the Survey Status. Select from ACTIVE or DEACTIVE
\n","type":"text/plain"},"key":"surveyStatus","value":"string"}],"variable":[]}},"response":[{"id":"f7b3df31-461a-c5ee-f873-501d1a74ad09","name":"Get Survey List","originalRequest":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"Your Zonka auth token goes here","description":"Your Zonka Auth token goes here"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.zonkafeedback.com/v2/surveys","protocol":"https","host":["api","zonkafeedback","com"],"path":["v2","surveys"],"query":[{"key":"locationId","value":"string","description":"Get list of surveys based on the location ID","disabled":true},{"key":"surveyStatus","value":"string","description":"Get list of surveys based on the Survey Status. Select from ACTIVE or DEACTIVE ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","description":""},{"name":"Connection","key":"Connection","value":"Keep-Alive","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json; charset=utf-8","description":""},{"name":"Date","key":"Date","value":"Mon, 19 Jun 2017 10:33:39 GMT","description":""},{"name":"Expires","key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":""},{"name":"Keep-Alive","key":"Keep-Alive","value":"timeout=5, max=100","description":""},{"name":"Server","key":"Server","value":"Apache/2.4.25 (Amazon) OpenSSL/1.0.1k-fips PHP/5.4.45","description":""},{"name":"Transfer-Encoding","key":"Transfer-Encoding","value":"chunked","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"PHP/5.4.45","description":""}],"cookie":[],"responseTime":"5206","body":"{\n \"status\": \"200\",\n \"response\": {\n \"totalRecords\": 3,\n \"dataList\": [\n {\n \"surveyId\": \"5292\",\n \"isScoring\": \"1\",\n \"surveyStatus\": \"active\",\n \"createdByUserId\": \"239\",\n \"createdDate\": \"2018-05-07 07:08:24\",\n \"modifiedByUserId\": \"239\",\n \"modifiedDate\": \"2018-05-10 09:24:24\",\n \"surveyName\": \"Customer Satisfaction Survey\",\n \"surveyDescription\": \"Survey for newly joined customers\",\n \"defaultLanguage\": \"en_US\",\n \"locationId\": \"34\"\n },\n {\n \"surveyId\": \"5228\",\n \"isScoring\": \"1\",\n \"surveyStatus\": \"active\",\n \"createdByUserId\": \"239\",\n \"createdDate\": \"2018-04-16 08:54:41\",\n \"modifiedByUserId\": \"239\",\n \"modifiedDate\": \"2018-04-17 09:05:28\",\n \"surveyName\": \"Current Customer Survey\",\n \"surveyDescription\": \"Survey for existing customer\",\n \"defaultLanguage\": \"en_US\",\n \"locationId\": \"35\"\n },\n {\n \"surveyId\": \"5185\",\n \"isScoring\": \"1\",\n \"surveyStatus\": \"active\",\n \"createdByUserId\": \"239\",\n \"createdDate\": \"2018-01-18 11:14:39\",\n \"modifiedByUserId\": \"239\",\n \"modifiedDate\": \"2018-04-16 11:39:36\",\n \"surveyName\": \"Ex Customer Survey\",\n \"surveyDescription\": \"Survey for ex customers\",\n \"defaultLanguage\": \"en_US\",\n \"locationId\": \"95\"\n }\n ]\n }\n}"}],"_postman_id":"5c003adb-20b4-fe9c-5bb4-348572cc16c8"},{"name":"Get Survey Details","id":"8a8b0bdd-b0da-0c78-c039-5214cc27c4c4","request":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"{{Z-API-TOKEN}}","description":"Your Zonka Auth token goes here
\n"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v2/surveys/{{surveyId}}","description":"Get details of one or more surveys by passing the responseId as path parameter.
\n","urlObject":{"protocol":"https","path":["v2","surveys","{{surveyId}}"],"host":["api","zonkafeedback","com"],"query":[],"variable":[]}},"response":[{"id":"c3a017cd-77e0-77c7-b3d6-d991219706e5","name":"Get Survey Details","originalRequest":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"Your Zonka auth token goes here","description":"Your Zonka Auth token goes here"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v1/surveys/4514"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","description":""},{"name":"Connection","key":"Connection","value":"Keep-Alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1600","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json; charset=utf-8","description":""},{"name":"Date","key":"Date","value":"Sat, 17 Jun 2017 07:24:51 GMT","description":""},{"name":"Expires","key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":""},{"name":"Keep-Alive","key":"Keep-Alive","value":"timeout=5, max=100","description":""},{"name":"Server","key":"Server","value":"Apache/2.4.25 (Amazon) OpenSSL/1.0.1k-fips PHP/5.4.45","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"PHP/5.4.45","description":""}],"cookie":[],"responseTime":"1158","body":"{\n \"status\": \"200\",\n \"response\": {\n \"data\": {\n \"surveyId\": \"5292\",\n \"isScoring\": \"1\",\n \"surveyStatus\": \"active\",\n \"surveyOrientation\": \"landscape\",\n \"surveyMode\": \"kiosk\",\n \"isClickThroughSurvey\": \"1\",\n \"autoTagging\": \"1\",\n \"allowNewResponseAlert\": \"1\",\n \"allowLowRatingResponseAlert\": \"1\",\n \"allowThanksGuestSmsAlert\": \"1\",\n \"allowLowRateGuestSmsAlert\": \"1\",\n \"createdByUserId\": \"239\",\n \"createdDate\": \"2018-05-07 07:08:24\",\n \"modifiedByUserId\": \"239\",\n \"modifiedDate\": \"2018-05-10 09:29:24\",\n \"surveyName\": \"Customer Satisfaction Survey\",\n \"surveyDescription\": \"Survey for customer satisfacton\",\n \"defaultLanguage\": \"en_US\"\n }\n }\n}"}],"_postman_id":"8a8b0bdd-b0da-0c78-c039-5214cc27c4c4"}],"id":"77b626aa-eb8e-32ce-e35e-6d8890043fca","description":"Get Survey list and Survey details associated with your Zonka account.
\n","_postman_id":"77b626aa-eb8e-32ce-e35e-6d8890043fca"},{"name":"Users","item":[{"name":"Get Users","id":"2dfa7027-d9aa-d389-49e5-a37aaf3fb06f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"NpMcL58Tck107ca218a31bc0cc168e3c22f1","description":"Your Zonka Auth token goes here
\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.zonkafeedback.com/v2/users","description":"Get list of users (staff) associated with your Zonka account.
\nPARAMS
\n","urlObject":{"protocol":"https","path":["v2","users"],"host":["api","zonkafeedback","com"],"query":[{"disabled":true,"description":{"content":"Get list of users based on locations assigned to them
\n","type":"text/plain"},"key":"locationId","value":"string"},{"disabled":true,"description":{"content":"Get list of users based on their status. Select from 'active' or 'deactive'
\n","type":"text/plain"},"key":"userStatus","value":"string"},{"disabled":true,"description":{"content":"Get list of users based on their role. Select from administrator, member, author or deviceuser
\n","type":"text/plain"},"key":"userRole","value":"string"},{"disabled":true,"description":{"content":"Get list of users based on their gender. Select from male or female
\n","type":"text/plain"},"key":"gender","value":"string"},{"disabled":true,"description":{"content":"Get list of users based on the tags assigned to them
\n","type":"text/plain"},"key":"userTags","value":"string"},{"disabled":true,"description":{"content":"Select the number of records to be fetched. 25 records are fetched by default
\n","type":"text/plain"},"key":"limit","value":"string"},{"disabled":true,"description":{"content":"Select the page number of the user list
\n","type":"text/plain"},"key":"page","value":"string"}],"variable":[]}},"response":[{"id":"040a50d6-1fd3-d99f-12be-65ba71bd1b85","name":"Get User List","originalRequest":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"{{Z-API-TOKEN}}","description":"Your Zonka Auth token goes here"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.zonkafeedback.com/v1/users","protocol":"https","host":["api","zonkafeedback","com"],"path":["v1","users"],"query":[{"key":"locationId","value":"string","description":"Get list of users based on locations assigned to them","disabled":true},{"key":"staffStatus","value":"string","description":"Get list of users based on their status. Select from 'active' or 'deactive'","disabled":true},{"key":"staffTags","value":"string","description":"Get list of users based on the tags assigned to them","disabled":true},{"key":"limit","value":"string","description":"Select the number of records to be fetched. 25 records are fetched by default","disabled":true},{"key":"page","value":"string","description":"Select the page number of the user list","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","description":""},{"name":"Connection","key":"Connection","value":"Keep-Alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"2794","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json; charset=utf-8","description":""},{"name":"Date","key":"Date","value":"Thu, 29 Jun 2017 11:42:12 GMT","description":""},{"name":"Expires","key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":""},{"name":"Keep-Alive","key":"Keep-Alive","value":"timeout=5, max=100","description":""},{"name":"Server","key":"Server","value":"Apache/2.4.25 (Amazon) OpenSSL/1.0.1k-fips PHP/5.4.45","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"PHP/5.4.45","description":""}],"cookie":[],"responseTime":"1317","body":"{\n \"status\": \"200\",\n \"response\": {\n \"totalRecords\": 2,\n \"currentRecords\": 2,\n \"dataList\": [\n {\n \"userId\": \"14545\",\n \"userStatus\": \"active\",\n \"fullName\": \"Adam Steve\",\n \"gender\": \"male\",\n \"locationId\": \"95,117,118,119,129,980\",\n \"userRole\": \"Manager\",\n \"userTags\": \"manager\"\n },\n {\n \"userId\": \"14395\",\n \"userStatus\": \"active\",\n \"fullName\": \"Mark Hussey\",\n \"gender\": \"male\",\n \"locationId\": \"All Locations\",\n \"userRole\": \"Administrator\",\n \"userTags\": \"new\"\n }\n ]\n }\n}"}],"_postman_id":"2dfa7027-d9aa-d389-49e5-a37aaf3fb06f"},{"name":"Get User Details","id":"1201eb71-8efd-1c10-b538-132092bfec9d","request":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"{{Z-API-TOKEN}}","description":"Your Zonka Auth token goes here
\n"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.zonkafeedback.com/v2/users/{{userId}}","description":"Get details of a specific user(staff) associated with your Zonka account.
\n","urlObject":{"protocol":"https","path":["v2","users","{{userId}}"],"host":["api","zonkafeedback","com"],"query":[{"disabled":true,"description":{"content":"Get list of surveys based on the location ID
\n","type":"text/plain"},"key":"locationId","value":"string"},{"disabled":true,"description":{"content":"Get list of surveys based on the Survey Status. Select from ACTIVE or DEACTIVE
\n","type":"text/plain"},"key":"surveyStatus","value":"string"}],"variable":[]}},"response":[{"id":"6e7015dd-8688-b778-69de-62693388bd9b","name":"Get User Details","originalRequest":{"method":"GET","header":[{"key":"Z-API-TOKEN","value":"{{Z-API-TOKEN}}","description":"Your Zonka Auth token goes here"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.zonkafeedback.com/v1/users/{{staffId}}","protocol":"https","host":["api","zonkafeedback","com"],"path":["v1","users","{{staffId}}"],"query":[{"key":"locationId","value":"string","description":"Get list of surveys based on the location ID","disabled":true},{"key":"surveyStatus","value":"string","description":"Get list of surveys based on the Survey Status. Select from ACTIVE or DEACTIVE ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0","description":""},{"name":"Connection","key":"Connection","value":"Keep-Alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"392","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json; charset=utf-8","description":""},{"name":"Date","key":"Date","value":"Thu, 29 Jun 2017 11:14:30 GMT","description":""},{"name":"Expires","key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":""},{"name":"Keep-Alive","key":"Keep-Alive","value":"timeout=5, max=100","description":""},{"name":"Server","key":"Server","value":"Apache/2.4.25 (Amazon) OpenSSL/1.0.1k-fips PHP/5.4.45","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"PHP/5.4.45","description":""}],"cookie":[],"responseTime":"1343","body":"{\n \"status\": \"200\",\n \"response\": {\n \"data\": {\n \"userId\": \"14545\",\n \"userStatus\": \"active\",\n \"fullName\": \"Adam Steve\",\n \"userRole\": \"Manager\",\n \"designation\": \"Customer Care Executive\",\n \"email\": \"steve@example.com\",\n \"mobile\": \"156567873\",\n \"gender\": \"male\",\n \"identifier\": \"23123\",\n \"locationId\": \"95,117,118,119,129,980\",\n \"dateOfJoining\": \"2017-06-22\",\n \"dateAddedOn\": \"2017-06-22 11:24:26\",\n \"lastModifiedDate\": \"2017-06-22 11:47:12\",\n \"lastActiveOn\": \"2017-06-23 11:32:59\",\n \"reportsTo\": \"John Barey\",\n \"listedInSurvey\": \"no\",\n \"userTags\": \"CX,Cafe\"\n }\n }\n}"}],"_postman_id":"1201eb71-8efd-1c10-b538-132092bfec9d"}],"id":"dbd56d00-5212-a512-05b6-e38e109d2f39","description":"This API enables you get list of users (staff) and user details associated with your Zonka account.
\n","_postman_id":"dbd56d00-5212-a512-05b6-e38e109d2f39"},{"name":"Send Email","item":[{"name":"Send Email","event":[{"listen":"test","script":{"id":"627cebfd-37f2-4ee9-85c9-f3eba03c5d71","type":"text/javascript","exec":["pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"200\");","});"]}},{"listen":"prerequest","script":{"id":"6e551fd4-a088-4198-8445-b75e58d38db5","type":"text/javascript","exec":[""]}}],"id":"9c89bdf3-3faa-7aa4-e4b0-34febbd01e6e","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Z-API-TOKEN","value":"{{Z-API-TOKEN}}"}],"body":{"mode":"formdata","formdata":[{"key":"email","value":"string","description":"EmailId of the recipient to which the email is to be sent
\n","type":"text","disabled":true},{"key":"firstName","value":"string","description":"First Name of the recipient
\n","type":"text","disabled":true},{"key":"lastName","value":"string","description":"Last Name of the recipient
\n","type":"text","disabled":true},{"key":"embed","value":"string","description":"Enables you to select if the first question in your survey should be embedded in the email. Set as 1 to embed or set as 0 if a Start Survey button should be included.
\n","type":"text","disabled":true},{"key":"subject","value":"string","description":"Subject of the email
\n","type":"text","disabled":true},{"key":"heading","value":"string","description":"Heading text in the email
\n","type":"text","disabled":true},{"key":"headingColor","value":"string","description":"Color of the heading text. Enter color Hex code
\n","type":"text","disabled":true},{"key":"buttonText","value":"string","description":"Content of the button.
\n","type":"text","disabled":true},{"key":"buttonTextColor","value":"string","description":"Color of the button bext. Enter color Hex code
\n","type":"text","disabled":true},{"key":"buttonColor","value":"string","description":"Color of the button. Enter color Hex code
\n","type":"text","disabled":true},{"key":"message","value":"string","description":"Content for message body of the email
\n","type":"text","disabled":true},{"key":"signature","value":"string","description":"Signature content at the end of the email
\n","type":"text","disabled":true},{"key":"list","value":"string","description":"Name of the list to tag with this recipient to.
\n","type":"text","disabled":true},{"key":"ignoreThrottling","value":"string","description":"Set as 1 if you want to ignore your survey throttling settings.
\n","type":"text","disabled":true}]},"url":"https://api.zonkafeedback.com/v2/sendemail/{{surveyId}}","description":"BODY PARAMS
\n","urlObject":{"protocol":"https","path":["v2","sendemail","{{surveyId}}"],"host":["api","zonkafeedback","com"],"query":[],"variable":[]}},"response":[{"id":"41d94f35-5705-4cac-8641-02258bf0c29a","name":"Send Email","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Z-API-TOKEN","value":"jsb3fi2UOg6a4e8c3cf33dd718f54c83d2a7"}],"body":{"mode":"formdata","formdata":[{"key":"email","value":"string","description":"Email id to send email to ","type":"text"},{"key":"firstName","value":"string","description":"First Name of the recipient","type":"text"},{"key":"lastName","value":"string","description":"Last Name of the recipient","type":"text"},{"key":"embed","value":"string","description":"Set as 1 to embed first question in email. To have Start Survey button, set as 0","type":"text"},{"key":"subject","value":"string","description":"Subject of the email","type":"text"},{"key":"heading","value":"string","description":"Heading text in the email","type":"text"},{"key":"headingColor","value":"string","description":"Color of the heading text","type":"text"},{"key":"buttonText","value":"string","description":"Content of the button","type":"text"},{"key":"buttonTextColor","value":"string","description":"Color of the content inside the button","type":"text"},{"key":"buttonColor","value":"string","description":"Color of the button","type":"text"},{"key":"message","value":"string","description":"Content for Message body of the email","type":"text"},{"key":"signature","value":"string","description":"Signature content at the end of the email ","type":"text"},{"key":"list","value":"string","description":"Name of the list to tag with this contact","type":"text"}]},"url":"https://api.zonkafeedback.com/v2/sendsms/{{surveyId}}"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"200\",\n \"response\": \"success\"\n}"}],"_postman_id":"9c89bdf3-3faa-7aa4-e4b0-34febbd01e6e"}],"id":"e0d353eb-2359-e49c-1a3e-b1e3354f4a49","description":"Send Email API enables you to send Emails to your recipients by passing the email id and other optional parameters. You can send two kind of emails using this API:
\nIf you want to send the email content that you have created on the Email Editor in Zonka, just pass the email id of the recipient in the API without adding any other customizing paramters.
\nIf you want to send the email survey with custom content that includes subject, message body and color for heading , pass the desired paramters and their value.
\nYou can pass additonal data as post paramters in the Send Email API. Before sending you will need to set up variable id for the survey fields which you intend to pass in the Send Email API. Variable id is a unique id assigned to question/field which you can set while editing the survey in the survey editor. To pass additonal paramters do the following:
\nMobile Number of the recipient to which the SMS is to be sent. Enter the number with country code but without + , brackets or spaces.
\n","type":"text","disabled":true},{"key":"message","value":"string","description":"Message to be sent to the recipient. Please intert the tag \"{URL}\" within the message where you want the survey link to appear. Inserting the {URL} tag is required to send SMS.
\n","type":"text","disabled":true},{"key":"firstName","value":"string","description":"First Name of the recipient
\n","type":"text","disabled":true},{"key":"lastName","value":"string","description":"Last Name of the recipient
\n","type":"text","disabled":true},{"key":"list","value":"string","description":"Name of the list to tag with this recipient to
\n","type":"text","disabled":true},{"key":"ignoreThrottling","value":"string","description":"Set as 1 if you want to ignore your survey throttling settings.
\n","type":"text","disabled":true}]},"url":"https://api.zonkafeedback.com/v2/sendsms/{{surveyId}}","description":"BODY PARAMS
\n","urlObject":{"protocol":"https","path":["v2","sendsms","{{surveyId}}"],"host":["api","zonkafeedback","com"],"query":[],"variable":[]}},"response":[{"id":"7a08d827-8352-414e-ae99-2e010027adb6","name":"Send SMS","originalRequest":{"method":"POST","header":[{"key":"Z-API-TOKEN","value":"jsb3fi2UOg6a4e8c3cf33dd718f54c83d2a7"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"mobile","value":"number","description":"Mobile number to send SMS to","type":"text"},{"key":"message","value":"string","description":"Content of the SMS to be sent ","type":"text"},{"key":"firstName","value":"string","description":"First Name of the recipient","type":"text"},{"key":"lastName","value":"string","description":"Last Name of the recipient","type":"text"},{"key":"list","value":"string","description":"Name of the list to tag with this contact","type":"text"}]},"url":"https://api.zonkaplatform.com/v2/sendsms/{{surveyId}}"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"200\",\n \"response\": \"success\"\n}"}],"_postman_id":"aca00f6c-dde6-204b-935c-8344ef180aaa"}],"id":"2ffff258-4c86-4047-c0df-533b38c4714d","description":"Send SMS API enables you to send SMS to your recipients by passing the mobile number and the message content.
\nIf you want to send the SMS content that you have created on the SMS Survey editor in Zonka, just pass the mobile number id of the recipient in the API without adding any other customizing paramters.
\nIf you want to send the SMS survey with custom content, pass your custom content in the 'message' parameter. Please include the placeholder tag {URL} witin the content which will be replaced with the Survey URL when delivered to the recipient.
\n\n\nPlease note, adding the {URL} tag is mandatory while adding custom content for sending SMS surveys.
\n
You can pass additonal data as post paramters in the Send Email API. Before sending you will need to set up variable id for the survey fields which you intend to pass in the Send Email API. Variable id is a unique id assigned to question/field which you can set while editing the survey in the survey editor. To pass additonal paramters do the following:
\n