{"info":{"_postman_id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","name":"Surveyr API","description":"

Surveyr is an open-source form builder that allows anyone to create engaging forms for surveys, questionnaires, quizzes, and polls.

Surveyr API is a simple API for integrating Surveyr forms into any application. It allows developers to manage, and retrieve survey data programmatically. Surveyr API makes it easy to embed surveys, quizzes, and polls into your workflows.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14546504","collectionId":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","publishedId":"2sAYQiBo9h","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-29T12:35:36.000Z"},"item":[{"name":"Authentication","item":[{"name":"Token","id":"7ac8ff73-5ef0-4fcc-8ef9-144089788887","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"admin@admin.com","type":"text"},{"key":"password","value":"password","type":"text"}]},"url":"https://surveyr.test/api/auth/token","urlObject":{"protocol":"https","path":["api","auth","token"],"host":["surveyr","test"],"query":[],"variable":[]}},"response":[{"id":"2fcc1d4a-6150-47be-8cdd-66b0291ddc3f","name":"Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"admin@admin.com","type":"text"},{"key":"password","value":"password","type":"text"}]},"url":"https://surveyr.test/api/auth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Jan 2025 11:08:57 GMT"},{"key":"Server","value":"Apache/2.4.59 (Win64) OpenSSL/3.0.11 PHP/8.2.12"},{"key":"X-Powered-By","value":"PHP/8.2.12"},{"key":"Access-Control-Allow-Origin","value":"surveyr.test"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,PUT,PATCH,POST,DELETE"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"PHPSESSID=qlpa6i7389hf260hs02p3njutl; path=/"},{"key":"Content-Length","value":"282"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Signed in successfully\",\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJzdXJ2ZXlyIiwiYXVkIjoic3VydmV5ciIsImlhdCI6MTczODE0ODkzNywibmJmIjoxNzM4MTQ4OTM3LCJleHAiOjE3NDU5MjQ5MzcsImRhdGEiOnsidXNlcl9pZCI6MX19.IW6MWqqefg87_rwH0Jyi9ULqwuyCbqDhoVhNxMZde_o\"\n}"}],"_postman_id":"7ac8ff73-5ef0-4fcc-8ef9-144089788887"}],"id":"9e48159a-d3fe-4405-b6e8-184466bb72e7","description":"

Surveyr API requires authentication for all its requests. Each request must include an Authorization header with a Bearer token. This token can be:

Issued on the go through authentication requests.
\n
Pre-issued in the admin panel by an admin user.
\n

For pre-issued tokens, an additional step is required to complete authorization. A key named passphrase, which was used during key issuance, must also be included in the request body or query parameters.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"91ad683d-eb4c-4884-a83a-e65d0332802f","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"885751d6-eec0-435a-a23e-10e7ce9c666b","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"9e48159a-d3fe-4405-b6e8-184466bb72e7"},{"name":"Forms","item":[{"name":"List Forms","id":"3a2e9cd5-d9a2-44ce-923e-0352a9b73a46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://surveyr.test/api/forms","description":"

Retrieves a list of all available forms that have been created. This allows users to browse the forms and select the one they need.

Fetches the full details of a specific form, including all its fields, question types, and configurations. This endpoint is useful when pre-filling or displaying a form dynamically.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJzdXJ2ZXlyIiwiYXVkIjoic3VydmV5ciIsImlhdCI6MTc1Mjg3NjMyOCwibmJmIjoxNzUyODc2MzI4LCJleHAiOjE3NjA2NTIzMjgsImRhdGEiOnsidXNlcl9pZCI6MX19.RrSYEohVAaNSYoK9EQSd8Rlzd5vZruHL9EZAJHNn6k4"}]},"isInherited":true,"source":{"_postman_id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","name":"Surveyr API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","forms","fetch",":formId"],"host":["surveyr","test"],"query":[],"variable":[{"type":"any","value":"string","key":"formId"}]}},"response":[{"id":"1a992ef7-e869-415b-93c6-8628067a6c46","name":"fetch","originalRequest":{"method":"GET","header":[],"url":"https://surveyr.test/api/forms/fetch/c4ca4238a0b923820dcc509a6f75849b"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Jan 2025 11:17:39 GMT"},{"key":"Server","value":"Apache/2.4.59 (Win64) OpenSSL/3.0.11 PHP/8.2.12"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/8.2.12"},{"key":"Access-Control-Allow-Origin","value":"surveyr.test"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,PUT,PATCH,POST,DELETE"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"PHPSESSID=hpuvdj5t0un6jqgqlnq8r1u4dl; path=/"},{"key":"Content-Length","value":"1953"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Form fetcheded successfully\",\n \"formStatus\": true,\n \"form\": {\n \"title\": \"Customer Feedback Survey\",\n \"description\": \"We value your feedback! Please answer a few questions.\",\n \"slug\": \"students-enrollment-6754497d5af4f\",\n \"questions\": [\n {\n \"name\": \"name\",\n \"title\": \"What is your name?\",\n \"isRequired\": true\n },\n {\n \"name\": \"satisfaction\",\n \"title\": \"How satisfied are you with our service?\",\n \"choices\": [\n \"Very Satisfied\",\n \"Satisfied\",\n \"Neutral\",\n \"Dissatisfied\",\n \"Very Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"recommend\",\n \"title\": \"How likely are you to recommend our service to others?\",\n \"isRequired\": true,\n \"maxRateDescription\": \"Very Likely\",\n \"minRateDescription\": \"Not Likely\"\n },\n {\n \"name\": \"feedback\",\n \"title\": \"Any other feedback?\",\n \"placeholder\": \"Enter your comments here...\"\n }\n ],\n \"user_id\": 1,\n \"collaborators\": [],\n \"spaces\": [],\n \"is_locked\": false,\n \"current_editor\": 0,\n \"is_indefinite\": false,\n \"reviews\": [\n \"reviewed\",\n \"pending\"\n ],\n \"submission_url\": null,\n \"webhook_url\": null,\n \"access_code\": null,\n \"theme\": \"ThreeDimensional\",\n \"start_date\": \"2024-12-13T21:00:00.000000Z\",\n \"end_date\": \"2025-02-11T21:00:00.000000Z\",\n \"created_at\": \"2024-12-07T13:11:25.000000Z\",\n \"updated_at\": \"2025-01-23T14:36:50.000000Z\"\n },\n \"publicForm\": true,\n \"surveyMode\": \"allowed\",\n \"formContent\": {\n \"pages\": [\n {\n \"name\": \"page1\",\n \"elements\": [\n {\n \"name\": \"name\",\n \"type\": \"text\",\n \"title\": \"What is your name?\",\n \"isRequired\": true\n },\n {\n \"name\": \"satisfaction\",\n \"type\": \"radiogroup\",\n \"title\": \"How satisfied are you with our service?\",\n \"choices\": [\n \"Very Satisfied\",\n \"Satisfied\",\n \"Neutral\",\n \"Dissatisfied\",\n \"Very Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"recommend\",\n \"type\": \"rating\",\n \"title\": \"How likely are you to recommend our service to others?\",\n \"isRequired\": true,\n \"maxRateDescription\": \"Very Likely\",\n \"minRateDescription\": \"Not Likely\"\n }\n ]\n },\n {\n \"name\": \"page2\",\n \"elements\": [\n {\n \"name\": \"feedback\",\n \"type\": \"comment\",\n \"title\": \"Any other feedback?\",\n \"placeholder\": \"Enter your comments here...\"\n }\n ]\n }\n ],\n \"title\": \"Customer Feedback Survey\",\n \"description\": \"We value your feedback! Please answer a few questions.\"\n }\n}"}],"_postman_id":"f9b719b3-6cb8-4d80-b1b4-7e04ea65994c"},{"name":"Fetch Multiple Forms","id":"25faa22c-f8d3-44d1-a2a6-d15c2e9b80eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"formId[]","value":"string","type":"text","uuid":"08136b35-96d0-44f3-8704-07e65aa1d105"}]},"url":"https://surveyr.test/api/forms","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJzdXJ2ZXlyIiwiYXVkIjoic3VydmV5ciIsImlhdCI6MTc1Mjg3NjMyOCwibmJmIjoxNzUyODc2MzI4LCJleHAiOjE3NjA2NTIzMjgsImRhdGEiOnsidXNlcl9pZCI6MX19.RrSYEohVAaNSYoK9EQSd8Rlzd5vZruHL9EZAJHNn6k4"}]},"isInherited":true,"source":{"_postman_id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","name":"Surveyr API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","forms"],"host":["surveyr","test"],"query":[],"variable":[]}},"response":[{"id":"0367c379-dad0-4aab-b61d-5f837cbe3609","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"formId[]","value":"4e732ced3463d06de0ca9a15b6153677","type":"text","uuid":"08136b35-96d0-44f3-8704-07e65aa1d105"},{"key":"formId[]","value":"8e296a067a37563370ded05f5a3bf3ec","type":"text","uuid":"a53e592a-73b5-4c88-83ae-2a61f36993a6"}]},"url":"https://surveyr.test/api/forms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 09 Feb 2025 08:22:06 GMT"},{"key":"Server","value":"Apache/2.4.63 (Win64) OpenSSL/3.0.15 PHP/8.2.27"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/8.2.27"},{"key":"Access-Control-Allow-Origin","value":"surveyr.test"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,PUT,PATCH,POST,DELETE"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"PHPSESSID=0ajnqasus78nlg92q8smnss0d5; path=/"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Forms fetched successfully\",\n \"forms\": [\n {\n \"id\": \"8e296a067a37563370ded05f5a3bf3ec\",\n \"title\": \"Research Questionnaire\",\n \"description\": \"Research Questionnaire\",\n \"slug\": \"research-questionaire-679e1c737dd43\",\n \"content\": {\n \"pages\": [\n {\n \"name\": \"page1\",\n \"title\": \"LMS Usage Background\",\n \"elements\": [\n {\n \"name\": \"usedLMS\",\n \"type\": \"radiogroup\",\n \"title\": \"Have you used any LMS systems?\",\n \"choices\": [\n {\n \"text\": \"Yes\",\n \"value\": \"yes\"\n },\n {\n \"text\": \"No\",\n \"value\": \"no\"\n }\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"LMSsystems\",\n \"type\": \"text\",\n \"title\": \"If yes, please mention them:\",\n \"visibleIf\": \"{usedLMS} = 'yes'\"\n },\n {\n \"name\": \"durationOfLMSUsage\",\n \"type\": \"text\",\n \"title\": \"How long have you used LMS systems?\",\n \"visibleIf\": \"{usedLMS} = 'yes'\"\n },\n {\n \"name\": \"encounteredChallenges\",\n \"type\": \"radiogroup\",\n \"title\": \"Have you encountered any challenges?\",\n \"choices\": [\n {\n \"text\": \"Yes\",\n \"value\": \"yes\"\n },\n {\n \"text\": \"No\",\n \"value\": \"no\"\n }\n ],\n \"visibleIf\": \"{usedLMS} = 'yes'\"\n },\n {\n \"name\": \"challengesExplanation\",\n \"type\": \"comment\",\n \"title\": \"Please explain the challenges you have encountered:\",\n \"visibleIf\": \"{encounteredChallenges} = 'yes'\"\n },\n {\n \"name\": \"benefitsGained\",\n \"type\": \"comment\",\n \"title\": \"What benefits have you gained from using LMS systems?\",\n \"visibleIf\": \"{usedLMS} = 'yes'\"\n },\n {\n \"name\": \"improvementsOrSuggestions\",\n \"type\": \"radiogroup\",\n \"title\": \"Do you have any improvements or feature suggestions?\",\n \"choices\": [\n {\n \"text\": \"Yes\",\n \"value\": \"yes\"\n },\n {\n \"text\": \"No\",\n \"value\": \"no\"\n }\n ],\n \"visibleIf\": \"{usedLMS} = 'yes'\"\n },\n {\n \"name\": \"improvementsExplanation\",\n \"type\": \"comment\",\n \"title\": \"Please explain your suggestions for improvements or features:\",\n \"visibleIf\": \"{improvementsOrSuggestions} = 'yes'\"\n }\n ]\n },\n {\n \"name\": \"page2\",\n \"elements\": [\n {\n \"name\": \"contactForFurtherQuestions\",\n \"type\": \"radiogroup\",\n \"title\": \"Would you like us to contact you for further questions?\",\n \"choices\": [\n {\n \"text\": \"Yes\",\n \"value\": \"yes\"\n },\n {\n \"text\": \"No\",\n \"value\": \"no\"\n }\n ]\n },\n {\n \"name\": \"contactName\",\n \"type\": \"text\",\n \"title\": \"Name:\",\n \"visibleIf\": \"{contactForFurtherQuestions} = 'yes'\"\n },\n {\n \"name\": \"contactEmail\",\n \"type\": \"text\",\n \"title\": \"Email:\",\n \"visibleIf\": \"{contactForFurtherQuestions} = 'yes'\",\n \"validators\": [\n {\n \"type\": \"email\"\n }\n ]\n },\n {\n \"name\": \"contactPhone\",\n \"type\": \"text\",\n \"title\": \"Phone Number:\",\n \"visibleIf\": \"{contactForFurtherQuestions} = 'yes'\"\n }\n ]\n }\n ],\n \"title\": \"Research Questionnaire\",\n \"description\": \"Research Questionnaire\"\n },\n \"questions\": [\n {\n \"name\": \"usedLMS\",\n \"title\": \"Have you used any LMS systems?\",\n \"choices\": [\n {\n \"text\": \"Yes\",\n \"value\": \"yes\"\n },\n {\n \"text\": \"No\",\n \"value\": \"no\"\n }\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"LMSsystems\",\n \"title\": \"If yes, please mention them:\",\n \"visibleIf\": \"{usedLMS} = 'yes'\"\n },\n {\n \"name\": \"durationOfLMSUsage\",\n \"title\": \"How long have you used LMS systems?\",\n \"visibleIf\": \"{usedLMS} = 'yes'\"\n },\n {\n \"name\": \"encounteredChallenges\",\n \"title\": \"Have you encountered any challenges?\",\n \"choices\": [\n {\n \"text\": \"Yes\",\n \"value\": \"yes\"\n },\n {\n \"text\": \"No\",\n \"value\": \"no\"\n }\n ],\n \"visibleIf\": \"{usedLMS} = 'yes'\"\n },\n {\n \"name\": \"challengesExplanation\",\n \"title\": \"Please explain the challenges you have encountered:\",\n \"visibleIf\": \"{encounteredChallenges} = 'yes'\"\n },\n {\n \"name\": \"benefitsGained\",\n \"title\": \"What benefits have you gained from using LMS systems?\",\n \"visibleIf\": \"{usedLMS} = 'yes'\"\n },\n {\n \"name\": \"improvementsOrSuggestions\",\n \"title\": \"Do you have any improvements or feature suggestions?\",\n \"choices\": [\n {\n \"text\": \"Yes\",\n \"value\": \"yes\"\n },\n {\n \"text\": \"No\",\n \"value\": \"no\"\n }\n ],\n \"visibleIf\": \"{usedLMS} = 'yes'\"\n },\n {\n \"name\": \"improvementsExplanation\",\n \"title\": \"Please explain your suggestions for improvements or features:\",\n \"visibleIf\": \"{improvementsOrSuggestions} = 'yes'\"\n },\n {\n \"name\": \"contactForFurtherQuestions\",\n \"title\": \"Would you like us to contact you for further questions?\",\n \"choices\": [\n {\n \"text\": \"Yes\",\n \"value\": \"yes\"\n },\n {\n \"text\": \"No\",\n \"value\": \"no\"\n }\n ]\n },\n {\n \"name\": \"contactName\",\n \"title\": \"Name:\",\n \"visibleIf\": \"{contactForFurtherQuestions} = 'yes'\"\n },\n {\n \"name\": \"contactEmail\",\n \"title\": \"Email:\",\n \"visibleIf\": \"{contactForFurtherQuestions} = 'yes'\",\n \"validators\": [\n {\n \"type\": \"email\"\n }\n ]\n },\n {\n \"name\": \"contactPhone\",\n \"title\": \"Phone Number:\",\n \"visibleIf\": \"{contactForFurtherQuestions} = 'yes'\"\n }\n ],\n \"is_locked\": false,\n \"current_editor\": 0,\n \"is_indefinite\": false,\n \"webhook_url\": null,\n \"access_code\": null,\n \"theme\": \"Contrast\",\n \"start_date\": \"2025-01-31T02:00:00.000000Z\",\n \"end_date\": \"2025-02-15T02:00:00.000000Z\",\n \"created_at\": \"2025-02-01T18:06:59.000000Z\",\n \"updated_at\": \"2025-02-01T18:13:10.000000Z\"\n },\n {\n \"id\": \"4e732ced3463d06de0ca9a15b6153677\",\n \"title\": \"TRAINING FEEDBACK FORM \",\n \"description\": \"Dear Participant, \\r\\nThank you for joining our training course. In order to improve our training courses we kindly ask you to take a few minutes to fill in this feedback form. \\r\\nIf you have any questions regarding this feedback form please consult the Camara trainer. \\r\\nYour Camara Team \\r\\n\\n\",\n \"slug\": \"training-feedback-form-67a0aa076bc46\",\n \"content\": {\n \"pages\": [\n {\n \"name\": \"Basic Information\",\n \"elements\": [\n {\n \"name\": \"schoolName\",\n \"type\": \"text\",\n \"title\": \"School name\",\n \"isRequired\": true\n }\n ],\n \"description\": \"Section 1. Basic information\"\n },\n {\n \"name\": \"Overall Course Feedback\",\n \"elements\": [\n {\n \"name\": \"courseRating\",\n \"type\": \"radiogroup\",\n \"title\": \"How would you rate the Training Course?\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"courseRelevance\",\n \"type\": \"radiogroup\",\n \"title\": \"The course was relevant to my current work or career path\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"timeSufficiency\",\n \"type\": \"radiogroup\",\n \"title\": \"There was sufficient time to complete the training course.\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"learningObjectivesOutlined\",\n \"type\": \"radiogroup\",\n \"title\": \"The learning objectives for this course were clearly outlined.\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"learningObjectivesAchieved\",\n \"type\": \"radiogroup\",\n \"title\": \"The learning objectives for this course were achieved.\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n }\n ],\n \"description\": \"Section 2. Overall Course Feedback \"\n },\n {\n \"name\": \"Course Structure and Documentation\",\n \"elements\": [\n {\n \"name\": \"courseStructureSatisfaction\",\n \"type\": \"radiogroup\",\n \"title\": \"The course was structured to your satisfaction\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"exercisesPracticalWork\",\n \"type\": \"radiogroup\",\n \"title\": \"How would you rate the exercises and/or practical work for this course?\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n }\n ],\n \"description\": \"Section 3. Course Structure and Documentation\"\n },\n {\n \"name\": \"Course Instruction and Delivery\",\n \"elements\": [\n {\n \"name\": \"instructorUnderstanding\",\n \"type\": \"radiogroup\",\n \"title\": \"The Instructor demonstrated a clear understanding of the course subject\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"presentationModel\",\n \"type\": \"radiogroup\",\n \"title\": \"How was the model of presentation/training\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n }\n ],\n \"description\": \"Section 4. Course Instruction and Delivery\"\n },\n {\n \"name\": \"Further Information\",\n \"elements\": [\n {\n \"name\": \"interestedSkills\",\n \"type\": \"checkbox\",\n \"title\": \"What additional ICT skills are you interested in acquiring/learning?\",\n \"choices\": [\n \"Basic Computer Skills\",\n \"Computer Troubleshooting & Maintenance\",\n \"Word\",\n \"Excel\",\n \"PowerPoint\",\n \"Using the Internet to search for information (learning resources)\",\n \"Developing digital content for my class\",\n \"Using smartphones for learning & teaching\",\n \"Integration of ICT in Teaching & Learning\",\n \"Internet & Email\"\n ],\n \"showOtherItem\": true\n },\n {\n \"name\": \"goodCourseAspects\",\n \"type\": \"checkbox\",\n \"title\": \"What did you find especially good about this course? (Multiple selections)\",\n \"choices\": [\n \"New ways of integrating ICT in teaching\",\n \"Ways to access digital content (material, apps, links)\",\n \"The importance of using ICT in education\"\n ],\n \"isRequired\": true,\n \"showOtherItem\": true\n },\n {\n \"name\": \"courseImprovement\",\n \"type\": \"comment\",\n \"title\": \"How can the course be improved in the future?\"\n },\n {\n \"name\": \"otherComments\",\n \"type\": \"comment\",\n \"title\": \"Any other comments?\"\n }\n ],\n \"description\": \"Section 5. Further Information \"\n }\n ],\n \"title\": \"TRAINING FEEDBACK FORM \",\n \"description\": \"Dear Participant, \\r\\nThank you for joining our training course. In order to improve our training courses we kindly ask you to take a few minutes to fill in this feedback form. \\r\\nIf you have any questions regarding this feedback form please consult the Camara trainer. \\r\\nYour Camara Team \\r\\n\\n\"\n },\n \"questions\": [\n {\n \"name\": \"schoolName\",\n \"title\": \"School name\",\n \"isRequired\": true\n },\n {\n \"name\": \"courseRating\",\n \"title\": \"How would you rate the Training Course?\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"courseRelevance\",\n \"title\": \"The course was relevant to my current work or career path\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"timeSufficiency\",\n \"title\": \"There was sufficient time to complete the training course.\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"learningObjectivesOutlined\",\n \"title\": \"The learning objectives for this course were clearly outlined.\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"learningObjectivesAchieved\",\n \"title\": \"The learning objectives for this course were achieved.\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"courseStructureSatisfaction\",\n \"title\": \"The course was structured to your satisfaction\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"exercisesPracticalWork\",\n \"title\": \"How would you rate the exercises and/or practical work for this course?\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"instructorUnderstanding\",\n \"title\": \"The Instructor demonstrated a clear understanding of the course subject\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"presentationModel\",\n \"title\": \"How was the model of presentation/training\",\n \"choices\": [\n \"Strongly Agree\",\n \"Agree or Reasonably Satisfied\",\n \"Neutral\",\n \"Disagree or Dissatisfied\",\n \"Strongly Disagree or Highly Dissatisfied\"\n ],\n \"isRequired\": true\n },\n {\n \"name\": \"interestedSkills\",\n \"title\": \"What additional ICT skills are you interested in acquiring/learning?\",\n \"choices\": [\n \"Basic Computer Skills\",\n \"Computer Troubleshooting & Maintenance\",\n \"Word\",\n \"Excel\",\n \"PowerPoint\",\n \"Using the Internet to search for information (learning resources)\",\n \"Developing digital content for my class\",\n \"Using smartphones for learning & teaching\",\n \"Integration of ICT in Teaching & Learning\",\n \"Internet & Email\"\n ],\n \"showOtherItem\": true\n },\n {\n \"name\": \"goodCourseAspects\",\n \"title\": \"What did you find especially good about this course? (Multiple selections)\",\n \"choices\": [\n \"New ways of integrating ICT in teaching\",\n \"Ways to access digital content (material, apps, links)\",\n \"The importance of using ICT in education\"\n ],\n \"isRequired\": true,\n \"showOtherItem\": true\n },\n {\n \"name\": \"courseImprovement\",\n \"title\": \"How can the course be improved in the future?\"\n },\n {\n \"name\": \"otherComments\",\n \"title\": \"Any other comments?\"\n }\n ],\n \"is_locked\": false,\n \"current_editor\": 0,\n \"is_indefinite\": true,\n \"webhook_url\": null,\n \"access_code\": null,\n \"theme\": \"Solid\",\n \"start_date\": \"2025-01-06T02:00:00.000000Z\",\n \"end_date\": null,\n \"created_at\": \"2025-02-03T16:34:49.000000Z\",\n \"updated_at\": \"2025-02-08T23:05:54.000000Z\"\n }\n ]\n}"}],"_postman_id":"25faa22c-f8d3-44d1-a2a6-d15c2e9b80eb"}],"id":"c9393620-d2b1-4c61-b7d2-a943b243850e","description":"

The Forms group provides endpoints for managing and retrieving survey forms. It allows users to list all available forms and fetch specific forms along with their structure. These endpoints are useful for dynamically displaying surveys, integrating forms into applications, and ensuring users can access the correct survey templates.

\n","_postman_id":"c9393620-d2b1-4c61-b7d2-a943b243850e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJzdXJ2ZXlyIiwiYXVkIjoic3VydmV5ciIsImlhdCI6MTc1Mjg3NjMyOCwibmJmIjoxNzUyODc2MzI4LCJleHAiOjE3NjA2NTIzMjgsImRhdGEiOnsidXNlcl9pZCI6MX19.RrSYEohVAaNSYoK9EQSd8Rlzd5vZruHL9EZAJHNn6k4"}]},"isInherited":true,"source":{"_postman_id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","name":"Surveyr API","type":"collection"}}},{"name":"Submissions","item":[{"name":"Single Submission","id":"6a7a902b-e263-4c45-8066-7da0a27cbe24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"formId","value":"string","type":"text","uuid":"3f1a3f50-9844-4ac6-82bc-9e01bc902904"},{"key":"content","value":"jsonString","type":"text","uuid":"0e5422b1-a6e5-4bd9-b7cc-671ff23589ca"}]},"url":"https://surveyr.test/api/collection/store","description":"

Submits a single user response to a form. The response is validated before being stored.

Allows submitting multiple responses to a single form in a batch request. This is useful for bulk data entry or offline submissions.

The Collection group handles the submission of survey responses. It includes endpoints for submitting single and multiple responses, ensuring that collected data is validated and stored efficiently. These endpoints support real-time and batch submissions, making it easy to collect data from various sources, including offline entries.

\n","_postman_id":"2bdfe380-8919-48f4-9c6c-321c5e4c3c3a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJzdXJ2ZXlyIiwiYXVkIjoic3VydmV5ciIsImlhdCI6MTc1Mjg3NjMyOCwibmJmIjoxNzUyODc2MzI4LCJleHAiOjE3NjA2NTIzMjgsImRhdGEiOnsidXNlcl9pZCI6MX19.RrSYEohVAaNSYoK9EQSd8Rlzd5vZruHL9EZAJHNn6k4"}]},"isInherited":true,"source":{"_postman_id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","name":"Surveyr API","type":"collection"}}},{"name":"Zones","item":[{"name":"Fetch Zone","item":[{"name":"All sheets","id":"edd802d0-2df1-41d2-b787-e73239d75787","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://surveyr.test/api/zones/show/abc123","description":"

Retrieve All Zone Information

This endpoint retrieves detailed information about a specific zone identified by zoneHash. It is particularly useful for obtaining data related to various attributes associated with the zone

Request

Method: GET
\n
URL: https://surveyr.test/api/zones/show/{zoneHash}
\n

Path Parameter:

zoneHash (string): A unique identifier for the zone whose information is being requested.

Response

On a successful request, the server responds with a status code of 200 and a JSON object containing details about the zone. The structure of the response is as follows:

Content-Type: application/json

{\n  \"Kenya\": [\n    {\n      \"Name\": \"Khadija\",\n      \"Region\": \"Mombasa\"\n    }\n  ],\n  \"Ethiopia\": [\n    {\n      \"Name\": \"Sample\",\n      \"County\": \"Sample2\"\n    }\n  ],\n  \"Tanzania\": [\n    {\n      \"Name\": \"Tumekuja Sec\",\n      \"Donor\": null,\n      \"Region\": \"Mjini Magharib\",\n      \"Country\": \"Tanzania \",\n      \"Project\": \" CCNMS\",\n      \"District \": null,\n      \"SchoolLevel\": \"secondary\"\n    }\n  ]\n}\n\n

\n","urlObject":{"protocol":"https","path":["api","zones","show","abc123"],"host":["surveyr","test"],"query":[],"variable":[]}},"response":[],"_postman_id":"edd802d0-2df1-41d2-b787-e73239d75787"},{"name":"Specific Sheet","id":"55a0d78f-47d1-43ce-817a-d094c60fb953","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://surveyr.test/api/zones/show/{sheetId}?sheet={sheetName}","description":"

This endpoint Returns a specific data sheet from the zone

[\n    {\n      \"Name\": \"Khadija\",\n      \"Region\": \"Mombasa\"\n    },\n    {\n      \"Name\": \"Alfasir Girls\",\n      \"Region\": \"Mombasa\"\n    }\n]\n\n

\n","urlObject":{"protocol":"https","path":["api","zones","show","{sheetId}"],"host":["surveyr","test"],"query":[{"description":{"content":"

i.e Kenya

\n","type":"text/plain"},"key":"sheet","value":"{sheetName}"}],"variable":[]}},"response":[],"_postman_id":"55a0d78f-47d1-43ce-817a-d094c60fb953"},{"name":"Search","id":"5065fd11-1990-4878-a219-fd68294a11ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://surveyr.test/api/zones/show/{sheetId}?sheet={sheeName}&search={string}&column={columName}","description":"

API Endpoint: Retrieve Zone Details

Method: GET
Endpoint: https://surveyr.test/api/zones/show/abc123

This endpoint retrieves detailed information about a specific zone identified by the abc123 identifier.

Query Parameters:

sheet (string): Specifies the sheet from which to retrieve data. In this case, it is set to Tanzania.
\n
search (string): This parameter is used to filter results based on a specific search term. Here, it is set to CCNMS.
\n
column (string): which is an optional parameter Indicates the column to be queried in the dataset. The current value is Project.
\n

Expected Response Format:

The response will return all the records in the sheet with associated record that is searched, so any record with a column that has the searched record with be returned

[\n    {\n      \"Name\": \"Tumekuja Sec\",\n      \"Donor\": null,\n      \"Region\": \"Mjini Magharib\",\n      \"Country\": \"Tanzania \",\n      \"Project\": \" CCNMS\",\n      \"District \": null,\n      \"SchoolLevel\": \"secondary\"\n    },\n    {\n      \"Name\": \"Dkt Samia Pri\",\n      \"Donor\": null,\n      \"Region\": \"Mjini Magharib\",\n      \"Country\": \"Tanzania \",\n      \"Project\": \" CCNMS\",\n      \"District \": null,\n      \"SchoolLevel\": \"Primary\"\n    }\n  ]\n\n

Optional parameter, if not provided the search will go through all columns to search for matches

\n","type":"text/plain"},"key":"column","value":"{columName}"}],"variable":[]}},"response":[],"_postman_id":"5065fd11-1990-4878-a219-fd68294a11ec"},{"name":"Sort Data","id":"395a34b8-c33a-47eb-a20e-336b1483e4ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://surveyr.test/api/zones/show/{sheetName}?sheet={sheet}&sort_by={column}&sort_order=asc","description":"

sample Responce

[\n    {\n        \"Name\": \"Alfasir Girls\",\n        \"Region\": \"Mombasa\"\n    },\n    {\n        \"Name\": \"Khadija\",\n        \"Region\": \"Mombasa\"\n    }\n]\n\n

\n","urlObject":{"protocol":"https","path":["api","zones","show","{sheetName}"],"host":["surveyr","test"],"query":[{"key":"sheet","value":"{sheet}"},{"description":{"content":"

The column you're trying to sort your data on

\n","type":"text/plain"},"key":"sort_by","value":"{column}"},{"description":{"content":"

The order you want to srot with, asc or desc

\n","type":"text/plain"},"key":"sort_order","value":"asc"}],"variable":[]}},"response":[],"_postman_id":"395a34b8-c33a-47eb-a20e-336b1483e4ec"}],"id":"85e53f0b-5a1b-4929-8636-68fb15d392fe","_postman_id":"85e53f0b-5a1b-4929-8636-68fb15d392fe","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJzdXJ2ZXlyIiwiYXVkIjoic3VydmV5ciIsImlhdCI6MTc1Mjg3NjMyOCwibmJmIjoxNzUyODc2MzI4LCJleHAiOjE3NjA2NTIzMjgsImRhdGEiOnsidXNlcl9pZCI6MX19.RrSYEohVAaNSYoK9EQSd8Rlzd5vZruHL9EZAJHNn6k4"}]},"isInherited":true,"source":{"_postman_id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","name":"Surveyr API","type":"collection"}}},{"name":"List Zones","id":"d3856f9c-aa92-46c6-b8ec-bc7ba0d07d29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://surveyr.test/api/zones","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJzdXJ2ZXlyIiwiYXVkIjoic3VydmV5ciIsImlhdCI6MTc1Mjg3NjMyOCwibmJmIjoxNzUyODc2MzI4LCJleHAiOjE3NjA2NTIzMjgsImRhdGEiOnsidXNlcl9pZCI6MX19.RrSYEohVAaNSYoK9EQSd8Rlzd5vZruHL9EZAJHNn6k4"}]},"isInherited":true,"source":{"_postman_id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","name":"Surveyr API","type":"collection"}},"urlObject":{"path":["api","zones"],"host":["https://surveyr.test"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3856f9c-aa92-46c6-b8ec-bc7ba0d07d29"}],"id":"ac4100b2-ee0b-46f0-bcfc-57454cc69582","description":"

Zones are collections of data that can be reused across your forms i.e countries, projects etc. The Zone public API provides an interface for advanced search, filtering, sorting, and formatting capabilities for better data presentation and access.

Zone structure

{\n  \"users\": [\n    {\n      \"id\": 1,\n      \"name\": \"John Doe\",\n      \"email\": \"john@example.com\",\n      \"role\": \"admin\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Jane Smith\", \n      \"email\": \"jane@example.com\",\n      \"role\": \"user\"\n    }\n  ],\n  \"products\": [\n    {\n      \"id\": 1,\n      \"name\": \"Product A\",\n      \"price\": 99.99,\n      \"category\": \"electronics\"\n    }\n  ]\n}\n\n\n

\n","event":[{"listen":"prerequest","script":{"id":"481a3a41-9714-4b59-88f4-054caa92a479","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"7c0579dc-071d-4fe6-abcb-e5bde6dadadc","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"ac4100b2-ee0b-46f0-bcfc-57454cc69582","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJzdXJ2ZXlyIiwiYXVkIjoic3VydmV5ciIsImlhdCI6MTc1Mjg3NjMyOCwibmJmIjoxNzUyODc2MzI4LCJleHAiOjE3NjA2NTIzMjgsImRhdGEiOnsidXNlcl9pZCI6MX19.RrSYEohVAaNSYoK9EQSd8Rlzd5vZruHL9EZAJHNn6k4"}]},"isInherited":true,"source":{"_postman_id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","id":"4495442e-3b83-42fb-8bfe-c2e3f33ed12a","name":"Surveyr API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJzdXJ2ZXlyIiwiYXVkIjoic3VydmV5ciIsImlhdCI6MTc1Mjg3NjMyOCwibmJmIjoxNzUyODc2MzI4LCJleHAiOjE3NjA2NTIzMjgsImRhdGEiOnsidXNlcl9pZCI6MX19.RrSYEohVAaNSYoK9EQSd8Rlzd5vZruHL9EZAJHNn6k4"}]}},"event":[{"listen":"prerequest","script":{"id":"721e039d-e2d7-4712-8909-39442626634d","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"3404bf8d-3f11-448e-ab16-c89e49f2dcd9","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://surveyr.test","type":"string"},{"key":"bearerToken","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJzdXJ2ZXlyIiwiYXVkIjoic3VydmV5ciIsImlhdCI6MTc1Mjg3NjMyOCwibmJmIjoxNzUyODc2MzI4LCJleHAiOjE3NjA2NTIzMjgsImRhdGEiOnsidXNlcl9pZCI6MX19.RrSYEohVAaNSYoK9EQSd8Rlzd5vZruHL9EZAJHNn6k4","type":"string"}]}