{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1502a09c-e3a1-42d2-974c-29181a739ee6","name":"SurveyXact REST API","description":"## About\n\nThe API provides access to automatically upload of respondents and retrieval of datasets from your organization's surveys in SurveyXact, as well as wide range of other information as can be done through the normal SurveyXact UI.\n\nThe solution is based on a RESTful architecture ([http://en.wikipedia.org/wiki/RESTful](http://en.wikipedia.org/wiki/RESTful))  \nand is accessed via HTTPS, which provides a number of benefits:\n\n- HTTPS is a secure protocol with encrypted data transfer.\n    \n- As the HTTPS port is open in most firewalls, this avoids problems concerning “permission” to contact our servers from the customer’s own IT environment.\n    \n\nThe solution uses SurveyXact’s built-in access control to ensure that users gain access  \nto only their own data.  \nRetrieved data is the most recent available from SurveyXact without any form of  \ncaching.\n\n## Available entities in the API\n\nInformation and attributes about the following entities can be retrieved:\n\n- Surveys\n    \n- Respondents\n    \n- Organizations\n    \n\nEach result contains a number of attributes for the required entity as well as a  \nnumber of links that can be used to run through the model from a given point.  \nIt is therefore easy to traverse the hierarchy and go from a respondent to a survey  \nto an organization etc.\n\n## Authentication\n\nAll requests must contain a valid username and password for a SurveyXact user  \nwho has access to the requested action and data.  \nThe user name and password must be transferred via Basic HTTP authentication ([http://en.wikipedia.org/wiki/Basic_access_authentication](http://en.wikipedia.org/wiki/Basic_access_authentication)).\n\n## Limitations of use\n\nThe customer has unlimited access to retrieve information on all available entities  \nin SurveyXact.  \nHowever, datasets must not be downloaded very frequently. Once an hour is acceptable  \nbut once a minute is too often.  \nThe acceptable frequency is assessed individually, and it will become a problem if  \nSurveyXact becomes overloaded due to too frequent requests.\n\n## Examples and test\n\nThe documentation contain examples of requests and responses. For instance, an endpoint may contain the text MY_SURVEY_KEY which indicates that you should insert a survey external key in the request.\n\n## Possible error codes\n\nThe most common error codes:\n\n##### 401 / 403 UNAUTHORIZED & FORBIDDEN\n\nAll requests need to be authenticated with a valid user. You might also be missing access to the resource you are trying to request or your organization does not have REST API access. Please check you credentials or contact support.\n\n##### 500 / 400 BAD_REQUEST & INTERNAL_SERVER_ERROR\n\nThese errors most often occur when there are errors in the request e.g. the parameter values are wrong. Unfortunatly not all our endpoints have great error messages when this happens - so please check the request path and parameters and contact support if you are still having issues.\n\n##### 415 UNSUPPORTED_MEDIA_TYPE\n\nThis error is due to a wrong body format. Please check the format of your request body and try again.\n\n##### 502 / 503 / 504 BAD_GATEWAY, GATEWAY_TIMEOUT & SERVICE_UNAVAILABLE\n\nOur systems are likely down. Please try again later.\n\n## Questions?\n\nIf you are having issues with an integration, please don't hesitate to contact us at [surveyxactsupport@ramboll.com](https://mailto:surveyxactsupport@ramboll.com)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1760772","collectionId":"1502a09c-e3a1-42d2-974c-29181a739ee6","publishedId":"S1a33ni6","public":true,"publicUrl":"https://documenter-api.postman.tech/view/1760772/S1a33ni6","privateUrl":"https://go.postman.co/documentation/1760772-1502a09c-e3a1-42d2-974c-29181a739ee6","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"009DF0"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"009DF0"}}]}},"version":"8.10.1","publishDate":"2026-03-04T13:44:30.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/4a0582990234fe289ba0e9c3e85a3409b4abace96d1e7828019bf34fd9f86bd2","favicon":"https://res.cloudinary.com/postman/image/upload/v1672991408/team/aojynxr5v3ovgdhlnqae.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/S1a33ni6"}