{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"fc9fdc73-6c88-4e31-a35c-0985d86d2136","name":"Survey Automator API","description":"## Survey Automator API\n\nSurvey Automator is a survey platform developed by Research Automators. This API provides access to your survey projects and and can be used to automate survey workflows.\n\n### Authentication\n\nAll requests are authenticated using a **bearer token**, sourced from the `ra-api-key` vault variable. The token is applied at the collection level and inherited by all requests.\n\nIf you need an API-key for testing or production please contact [helpdesk@researchautomators.com](https://mailto:helpdesk@researchautomators.com)\n\n### Structure\n\nRequests are organized under the **Projects** folder and currently cover the following operations:\n\n| Request | Method | Description |\n| --- | --- | --- |\n| List Projects | `GET` | Retrieve a list of all available projects |\n| Project by ID | `GET` | Fetch details of a specific project |\n| List Project Tasks | `GET` | Retrieve all tasks belonging to a project |\n| Project Task by ID | `GET` | Fetch details of a specific task within a project |\n| Add Project Task | `POST` | Create a new task under a survey project |\n| Download File | `GET` | Download a file generated by task |\n| Upload file | POST | Upload a file for using it in import task |\n\n### Variables\n\nThe collection relies on the following environment variables:\n\n- `BaseURL` — the base API URL ([https://app.researchautomators.com](https://app.researchautomators.com) in production)\n    \n- `projectID` — the ID of the target project\n    \n- `taskID` — the ID of a specific task\n    \n- `fileName` — the full name of the file to download\n    \n- `fileName2` — the full name of the file to import where all backslashes are doubled\n    \n- `vault:ra-api-key` — secret API key stored in local vault\n    \n\n### Flow examples\n\n#### Retreiving survey response data\n\n1. List Projects → find the ID of your target project\n    \n2. Add Project Task → Use actionType : ResponsesExport → Save task ID\n    \n3. Project Task By ID → Continously poll status using task ID → Get file name\n    \n4. Download file → When the file is done retreive it using file name\n    \n\n#### Refresh / sync a survey project\n\nSynchronizing a projects gets the latest response updates in a survey project\n\n1. List Projects → find the ID of your target project\n    \n2. Add Project Task → Use actionType : Synchronize\n    \n3. Optional: Save task ID\n    \n4. Optional: Use task ID to poll for synchronize success (usually takes a few seconds)\n    \n\n#### Importing survey participants\n\n1. List Projects → find the ID of your target project\n    \n2. Add Project Task → Use actionType : ResponsesImport\n    \n3. Add participants below parameters → data\n    \n\n#### Importing responses from uploaded file\n\n1. List Projects → find the ID of your target project\n    \n2. Upload responses file\n    \n3. Add Project Task → Use actionType : ResponsesImport\n    \n4. Add reference to uploaded file below parameters → file","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"17386769","team":6539900,"collectionId":"fc9fdc73-6c88-4e31-a35c-0985d86d2136","publishedId":"2sBXihqD2h","public":true,"publicUrl":"https://apidoc.researchautomators.se","privateUrl":"https://go.postman.co/documentation/17386769-fc9fdc73-6c88-4e31-a35c-0985d86d2136","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4737ff"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":"Survey Automator is a survey platform focused on automation for survey and research professionals"},{"name":"title","value":"Survey Automator API docs"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/0c1ea1cd-2713-4ac7-b716-0e1089dc6506/cmVzZWFyY2gtYXV0b21hdG9ycy12aXQtNjAwLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"4737ff"}},{"name":"light","logo":"https://content.pstmn.io/a9a3233e-9441-4273-a788-1be0f109064d/cmVzZWFyY2gtYXV0b21hdG9ycy1zdmFydC02MDAucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4737ff"}}]}},"version":"8.10.1","publishDate":"2026-03-18T13:50:22.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Survey Automator API docs","description":"Survey Automator is a survey platform focused on automation for survey and research professionals"},"logos":{"logoLight":"https://content.pstmn.io/a9a3233e-9441-4273-a788-1be0f109064d/cmVzZWFyY2gtYXV0b21hdG9ycy1zdmFydC02MDAucG5n","logoDark":"https://content.pstmn.io/0c1ea1cd-2713-4ac7-b716-0e1089dc6506/cmVzZWFyY2gtYXV0b21hdG9ycy12aXQtNjAwLnBuZw=="}},"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/5e5fbd42d0d024953800a831b50541110f4d12d118933f58cc48dd8af7027719","favicon":"https://researchautomators.se/favicon.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://apidoc.researchautomators.se/view/metadata/2sBXihqD2h"}