CINXE.COM
Getting Started
<!DOCTYPE html><html lang="en" style="" data-color-mode="light" class=" useReactApp "><head><script src="https://cdn.readme.io/public/js/force-firefox-anchor-jump.js?1733251405407"></script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="readme-deploy" content="5.239.0"><meta name="readme-subdomain" content="smartsurvey"><meta name="readme-version" content="1"><title>Getting Started</title><meta name="description" content="Welcome to the documentation for the SmartSurvey API. Here we will explain to you how to authenticate your API calls, what error codes we use, how we do versioning, and how you can use the API."><meta property="og:title" content="Getting Started"><meta property="og:description" content="Welcome to the documentation for the SmartSurvey API. Here we will explain to you how to authenticate your API calls, what error codes we use, how we do versioning, and how you can use the API."><meta property="og:site_name" content="SmartSurvey API"><meta name="twitter:title" content="Getting Started"><meta name="twitter:description" content="Welcome to the documentation for the SmartSurvey API. Here we will explain to you how to authenticate your API calls, what error codes we use, how we do versioning, and how you can use the API."><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:image" content="https://files.readme.io/c59d98f-small-smartsurvey-logo-on-white-large.png"><meta name="twitter:image" content="https://files.readme.io/c59d98f-small-smartsurvey-logo-on-white-large.png"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/7da1d2d-favicon.ico" type="image/x-icon"><link rel="canonical" href="https://docs.smartsurvey.io/docs/getting-started"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1733251405407"></script><link data-chunk="New" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/New.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.d9c673efc10d86fdf1b5.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="routes-Changelog" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-PageNotFound" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.a810b19040de05f1c1ce.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/8263.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.2415ba38e8e5c2ba190e.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.de26ae77a22f63cc7421.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.b8520cde412c1642dc0b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.1912e092b9c8785ff5c3.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3284.6ecd6ef27e2009d3fdc7.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/572.bab1eda8453360a8a761.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2406.951963c0cf542b4b86a4.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.6288c030d5183baa5a89.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7112.69c3d611e7e54e411b26.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/73.535ee2b3bfca871baf6d.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8263.3d098f45b4b562ec80b5.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1282.591f476c316bf3670bbd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.49bb02ec5acf87fd228c.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3880.3892311d81c548cb073c.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.48ca7ef3a5c469d97e53.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.9119a4e00e8cb781f8b7.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6841.587d285d41ca8bab11b1.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6722.386671bc80030984d9c0.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.e3a4e0817a9a640436bc.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.js"> <link data-chunk="core-icons-arrow-up-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.a0c700eb9ae5192d6433.js"> <link data-chunk="core-icons-alert-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"> <link data-chunk="core-icons-x-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"> <link data-chunk="core-icons-suggested-edits-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4002.08d1caef58d08eaccd19.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.4f1c8dfacfeed0a6ea87.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7971.db270c2970b791e38435.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/153.e4db5a313c7d51383015.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.d66a49f09580aafdabb6.js"> <link data-chunk="core-icons-more-vertical-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"> <link data-chunk="core-icons-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2859.94b03b9a9585460aa921.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.18ddfae65f140c2e4c1e.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.cced33af5051de7f473f.js"> <link data-chunk="core-icons-eye-off-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"> <link data-chunk="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.3a8d675d9cf79a25b071.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.a5df1d5e240762d7981f.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4674.13378da16ce7b5beba66.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.12cee315afa198c8e23e.js"> <link data-chunk="core-icons-trending-up-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"> <link data-chunk="core-icons-callout-info-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"> <link data-chunk="core-icons-chevron-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"> <link data-chunk="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.8adf2bf8562dfeff14b4.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.65c6f721688901333944.js"> <link data-chunk="core-icons-message-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"> <link data-chunk="core-icons-search-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"> <link data-chunk="core-icons-custom-pages-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.3337538299592ef842e6.js"> <link data-chunk="core-icons-star-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"> <link data-chunk="rmdx" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"> <link data-chunk="core-icons-webhook-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"> <link data-chunk="New" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/New.908bc26e77bebc585452.js"> <link data-chunk="core-icons-key-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.de26ae77a22f63cc7421.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.2415ba38e8e5c2ba190e.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/8263.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.a810b19040de05f1c1ce.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="Page" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.d9c673efc10d86fdf1b5.css"> <link data-chunk="New" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/New.f8e4e9e20d429e588f3c.css"><!-- CUSTOM CSS--><style title="rm-custom-css">:root{--project-color-primary:#ff6b00;--project-color-inverse:#222;--recipe-button-color:#ff6b00;--recipe-button-color-hover:#994000;--recipe-button-color-active:#662b00;--recipe-button-color-focus:rgba(255, 107, 0, 0.25);--recipe-button-color-disabled:#ffe1cc}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#ff6b00;--project-color-inverse:#222}a{color:var(--color-link-primary,#ff6b00)}a:hover{color:var(--color-link-primary-darken-5,#994000)}a.text-muted:hover{color:var(--color-link-primary,#ff6b00)}.btn.btn-primary{background-color:#ff6b00}.btn.btn-primary:hover{background-color:#994000}.theme-line #hub-landing-top h2{color:#ff6b00}#hub-landing-top .btn:hover{color:#ff6b00}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#ff6b00}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#ff6b00,#b34b00)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(undefined)}.theme-line header#hub-header #header-top{border-bottom-color:#ff6b00}.theme-line header#hub-header #header-top .btn{background-color:#ff6b00}header#hub-header #header-top #header-logo{width:217px;height:40px;margin-top:0;background-image:url(https://files.readme.io/c59d98f-small-smartsurvey-logo-on-white-large.png)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#ff6b00}#subheader-links a.active{color:#ff6b00!important;box-shadow:inset 0 -2px 0 #ff6b00}#subheader-links a:hover{color:#ff6b00!important;box-shadow:inset 0 -2px 0 #ff6b00;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#ff6b00}section#hub-discuss .discussion a .discuss-body h4{color:#ff6b00}section#hub-discuss .discussion a:hover .discuss-body h4{color:#994000}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#ff6b00}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#ff6b00}#hub-search-results h3 em{color:#ff6b00}.main_background,.tag-item{background:#ff6b00!important}.main_background:hover{background:#994000!important}.main_color{color:#ff6b00!important}.border_bottom_main_color{border-bottom:2px solid #ff6b00}.main_color_hover:hover{color:#ff6b00!important}section#hub-discuss h1{color:#ff6b00}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#ff6b00;background-color:#ff6b00}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#994000;border-color:#994000}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#ff6b00;color:#ff6b00}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#ff6b00);border-color:var(--project-color-primary,#ff6b00)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#994000;border-color:#994000}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#ff6b00;fill:var(--project-color-primary,#ff6b00)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#ff6b00}.main-color-accent{border-bottom:3px solid #ff6b00;padding-bottom:8px}/*! BEGIN HUB_CUSTOM_STYLES *//*! END HUB_CUSTOM_STYLES */</style><meta name="google-site-verification" content="Czv3_HDgdJfsd3zhAEyFhzyL3d3tGNE4QD4rpcIHeb4"><meta name="loadedProject" content="smartsurvey"><script>var storedColorMode = `light` === 'system' ? window.localStorage.getItem('color-scheme') : `light` document.querySelector('[data-color-mode]').setAttribute('data-color-mode', storedColorMode)</script><script id="config" type="application/json" data-json="{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.239.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-threes theme-line header-solid header-bg-size-auto header-bg-pos-tl header-overlay-triangles reference-layout-row lumosity-normal "><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark ThemeContext_line" style="--color-primary:#ff6b00;--color-primary-inverse:#fff;--color-primary-alt:#b34b00;--color-primary-darken-10:#cc5600;--color-primary-darken-20:#994000;--color-primary-alpha-25:rgba(255, 107, 0, 0.25);--color-link-primary:#ff6b00;--color-link-primary-darken-5:#e66000;--color-link-primary-darken-10:#cc5600;--color-link-primary-darken-20:#994000;--color-link-primary-alpha-50:rgba(255, 107, 0, 0.5);--color-link-primary-alpha-25:rgba(255, 107, 0, 0.25);--color-link-background:rgba(255, 107, 0, 0.09);--color-link-text:#fff;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"><header class="Header3zzata9F_ZPQ rm-Header "><div class="rm-Header-top Header-topuTMpygDG4e1V"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="https://www.smartsurvey.co.uk" target="_self"><img alt="SmartSurvey API" class="rm-Logo-img Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/c59d98f-small-smartsurvey-logo-on-white-large.png"/></a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="/" target="_self">Home</a><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text rm-Header-top-link_active Header-link2tXYTgXq85zW active" href="/docs" target="_self">Guides</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="/reference" target="_self">API Reference</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Guides</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/reference" target="_self"><i class="icon-references NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">API Reference</span></a><select class="Select Select_md NavItem-item1gDDTqaXGhm1 NavItem-item_select3UEfLN-oSjxp NavItem-item_mobile1qG3gd-Mkck-"><option selected="" data-url="#" value="1">v1</option><option data-url="/v2/docs" value="2">v2</option></select><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/" target="_self">Home</a><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74 active" href="/docs" target="_self">Guides</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/reference" target="_self">API Reference</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="https://www.smartsurvey.co.uk" target="_self"><img alt="SmartSurvey API" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/c59d98f-small-smartsurvey-logo-on-white-large.png"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-guides Header-left-nav-icon10glJKFwewOv"></i>Guides</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"></span><div class="Header-searchtb6Foi0-D9Vx"><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div></button></div></div></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav class="Header-leftADQdGVqx1wqU"><div class="rm-VersionDropdown Dropdown Dropdown_closed"><button aria-haspopup="dialog" class="Button Button_slate_text Button_md rm-Header-bottom-link Dropdown-toggle Button_primary" type="button"><span>v<!-- -->1</span><i class="icon icon-chevron-down"></i></button></div><div class="Dropdown Dropdown_closed"><div class="Dropdown-toggle" aria-haspopup="dialog"><button class="rm-Header-link rm-Header-bottom-link undefined Button Button_slate_text Button_md" type="button"><span>Guides</span><i class="undefined icon-chevron-down"></i></button></div></div><span class="rm-Header-link rm-Header-bottom-link undefined NavItem_inactive1YE6SGanIJp5">Getting Started</span></nav><button align="center" justify="between" style="--flex-gap:var(--xs)" class="Button Button_sm Flex Flex_row MobileSubnav1DsTfasXloM2 Button_contrast Button_contrast_outline" type="button"><span class="Button-label">Getting Started</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-up-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 16 6 6 6-6M18 8l-6-6-6 6" class="icon-stroke-width"></path></svg></span></button><div class="rm-Header-search Header-searchtb6Foi0-D9Vx rm-Header-search_feather Header-search_featherYsmQBn55F3d9"><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div><div class="Header-search-placeholder3Vx4OmMPcjAi rm-SearchToggle-placeholder">Search</div><div class="rm-SearchToggle-shortcut"></div></button></div></div></div><div class="hub-search-results--reactApp " id="hub-search-results"><div class="hub-container"><div class="modal-backdrop show-modal rm-SearchModal" role="button" tabindex="0"></div></div></div></header><main class="rm-Guides"><div class="rm-Container rm-Container_flex"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj rm-Sidebar_guides" id="hub-sidebar"><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">API</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link active" target="_self" href="/docs/getting-started"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Getting Started</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/errors"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Errors</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/rate-limiting"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Access & Rate Limiting</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/data-types"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Data Types</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">WEB HOOKS</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/webhooks-introduction"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/samples"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Samples</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/errors-1"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Errors</span></span></a></li></ul></section><div class="readme-logo" id="readmeLogo">Powered by <a aria-label="ReadMe" href="https://readme.com?ref_src=hub&project=smartsurvey" style="color:unset"><i class="icon icon-readme" style="display:inline-block;min-width:71px"></i></a></div></div></nav><article class="rm-Article " id="content"><header id="content-head"><div class="row clearfix"><div class="col-xs-9"><h1>Getting Started</h1><div class="excerpt"><div class="rm-Markdown markdown-body" data-testid="RDMD"><p>Welcome to the documentation for the SmartSurvey API. Here we will explain to you how to authenticate your API calls, what error codes we use, how we do versioning, and how you can use the API.</p></div></div></div><div class="col-xs-3"><a class="suggestEdits" rel="nofollow" href="/edit/getting-started"><i aria-hidden="true" class="icon icon-edit"></i> Suggest Edits</a></div></div></header><div class="grid-container-fluid" id="content-container"><section class="content-body grid-75"><div dehydrated="<h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="api-basics"></div><div class="heading-text"><div id="section-api-basics" class="heading-anchor_backwardsCompatibility"></div>API Basics</div><a aria-label="Skip link to API Basics" class="heading-anchor-icon fa fa-anchor" href="#api-basics"></a></h2> <p>The SmartSurvey API gives you access to secure survey data for use in your own app. It strives to be RESTful and is organised around the main resources you’re familiar with from the SmartSurvey web interface.</p> <p>Before you do anything, you should make sure you have a SmartSurvey account that you can test the API against and register for an API key so that you can make API calls.</p> <p>The SmartSurvey API is a RESTful API, which adheres to the guidelines defined by REST. You can read more information about REST on the following link:<br/> <a href="https://en.wikipedia.org/wiki/Representational_state_transfer#RESTful_web_services" target="" title="">https://en.wikipedia.org/wiki/Representational_state_transfer#RESTful_web_services</a></p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="getting-your-api-key"></div><div class="heading-text"><div id="section-getting-your-api-key" class="heading-anchor_backwardsCompatibility"></div>Getting Your API Key</div><a aria-label="Skip link to Getting Your API Key" class="heading-anchor-icon fa fa-anchor" href="#getting-your-api-key"></a></h2> <p>In order to use SmartSurvey API, you will need to request an API key from within your account dashboard. </p> <p>Follow the steps below to get your API key:</p> <ul> <li>Login to your account</li> <li>Click on My Account</li> <li>Click on API Keys</li> <li>Request API Access</li> <li>If you have not already requested one, click on request key.</li> <li>Click Add New API Key</li> <li>Once the key appears, use this to authenticate with the API</li> </ul> <p>If you do not see this option within your account, please <a href="https://www.smartsurvey.co.uk/contact" target="" title="">contact us</a> for further assistance.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="authentication"></div><div class="heading-text"><div id="section-authentication" class="heading-anchor_backwardsCompatibility"></div>Authentication</div><a aria-label="Skip link to Authentication" class="heading-anchor-icon fa fa-anchor" href="#authentication"></a></h2> <p>Your API requests must use <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme" target="" title="">Basic Auth</a> for authentication. All API tooling should support this mechanism which should encode your api token and secret into a specific format, which is then passed in an HTTP header like this:</p> <p><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">Authorization: Basic &lt;token&gt;</code></p> <p>You should not need to create this header manually, which is slightly complicated and which can cause various errors if not done correctly.</p> <p>Failed authentication will return an HTTP 401 Unauthorized response.</p> <p>Previously, we supported querystring parameters but these are now <em>deprecated</em> and all requests should switch to using Basic auth.</p> <p>E.g. <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">https://api.smartsurvey.io/v1/surveys?api_token=XXXXX&amp;api_token_secret=XXXXX</code></p> <p>Note that if you are migrating to using Basic Auth, as soon as you provide an Authorization http header, the querystring parameters will be ignored even if they are correct. For this reason, a malformed Authorization header will cause a 401 even if you are still passing the querystring parameters.</p> <blockquote class="callout callout_warn" theme="🚧"><h2 class="callout-heading"><span class="callout-icon">🚧</span><p>Basic Auth, Usernames and Passwords</p></h2><p>Some Basic Auth examples and documentation, and the test function on the API refrerence pages, will refer to a &quot;Username&quot; and &quot;Password&quot;. In the context of SmartSurvey API requests, &quot;Username&quot; is the API Token. &quot;Password&quot; is the Token Secret.</p><p>Do not try and use your SmartSurvey login credentials. This will not work, and will generate a 401 error.</p></blockquote> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="example-api-request"></div><div class="heading-text"><div id="section-example-api-request" class="heading-anchor_backwardsCompatibility"></div>Example API Request</div><a aria-label="Skip link to Example API Request" class="heading-anchor-icon fa fa-anchor" href="#example-api-request"></a></h2> <p><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">GET https://api.smartsurvey.io/v1/surveys</code></p> <p>In this example, the returned content will be inferred from the authenticated account i.e. you will get a list of all surveys linked to the authenticated account.</p> <p><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">GET https://api.smartsurvey.io/v1/surveys/12345</code></p> <p>In this example, when requesting a specific object (e.g. survey 12345), then if you are not permitted to access it with the authenticated account, you will receive am HTTP 403 Forbidden response.</p> <p>If using POST or PUT, you must use either application/json, text/xml or application/xml as the content-type for the request, with the body formatted accordingly otherwise you will receive a 415 error response.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="output-formats"></div><div class="heading-text"><div id="section-output-formats" class="heading-anchor_backwardsCompatibility"></div>Output Formats</div><a aria-label="Skip link to Output Formats" class="heading-anchor-icon fa fa-anchor" href="#output-formats"></a></h2> <p>The SmartSurvey API provides the output/response for an API request in the following<br/> formats.</p> <div class="rdmd-table"><div class="rdmd-table-inner"><table><thead><tr><th style="text-align:left">Format</th><th style="text-align:left">Accept Header</th></tr></thead><tbody><tr><td style="text-align:left"><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">JSON</code><br/><em>default</em></td><td style="text-align:left">application/json</td></tr><tr><td style="text-align:left"><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">XML</code></td><td style="text-align:left">application/xml</td></tr></tbody></table></div></div> <p>You can change the output format by providing an &quot;Accept&quot; request header with the above values.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="pagination"></div><div class="heading-text"><div id="section-pagination" class="heading-anchor_backwardsCompatibility"></div>Pagination</div><a aria-label="Skip link to Pagination" class="heading-anchor-icon fa fa-anchor" href="#pagination"></a></h2> <p>Some endpoints that return arrays support <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">page</code> and <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">page_size</code> as URL parameters. <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">page</code> defines the page index and <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">page_size</code> defines the number of records that will be returned on a page. The number of records is not guaranteed to be the number specified as visibility rules may filter out items. </p> <p><b>Query Parameters:</b></p> <ul> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">page</code> – page of records to return (defaults to 1)</li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">page_size</code> – number of records to return per page (defaults to 10, max is 100)<br/> If successful, you should receive the following custom headers in your response:</li> </ul> <p>For example:<br/> https://<span></span>api.smartsurvey.io/v/1/surveys/{surveyId}/responses/?<strong>page=1</strong>&amp;<strong>page_size=100</strong></p> <div class="rdmd-table"><div class="rdmd-table-inner"><table><thead><tr><th style="text-align:left"></th><th style="text-align:left"></th></tr></thead><tbody><tr><td style="text-align:left"><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">X-SS-Pagination-Page</code></td><td style="text-align:left">The page number requested.</td></tr><tr><td style="text-align:left"><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">X-SS-Pagination-PageSize</code></td><td style="text-align:left">Number of rows requested.</td></tr><tr><td style="text-align:left"><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">X-SS-Pagination-Total</code></td><td style="text-align:left">The total number of rows found in database.</td></tr><tr><td style="text-align:left"><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">X-SS-Pagination-Returned</code></td><td style="text-align:left">The total number of rows returned.</td></tr></tbody></table></div></div> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="date-formats"></div><div class="heading-text"><div id="section-date-formats" class="heading-anchor_backwardsCompatibility"></div>Date Formats</div><a aria-label="Skip link to Date Formats" class="heading-anchor-icon fa fa-anchor" href="#date-formats"></a></h2> <p>NOTE: . </p> <p>Date-time information is always returned in UTC and ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). You will need to adjust the timezone to suit your needs.</p> <p>Dates sent to the API must be Unix epoch timestamp and should be formatted as shown in the example below: </p> <p>Example: Fri, 01 Jan 2016 00:00:00 UTC = 1451606400 (UTC Timestamp)</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="versioning"></div><div class="heading-text"><div id="section-versioning" class="heading-anchor_backwardsCompatibility"></div>Versioning</div><a aria-label="Skip link to Versioning" class="heading-anchor-icon fa fa-anchor" href="#versioning"></a></h2> <p>This REST API version v1 is our first API version. The API version is likely to change from v1 to vN {N = 1 …. n} if any structural changes are made to the existing version.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="security"></div><div class="heading-text"><div id="section-security" class="heading-anchor_backwardsCompatibility"></div>Security</div><a aria-label="Skip link to Security" class="heading-anchor-icon fa fa-anchor" href="#security"></a></h2> <p>All function calls included in SmartSurvey API are provided over https (Transport Layer Security). This ensures that your data is transmitted through a secure channel between our server and your client.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="include-labels"></div><div class="heading-text"><div id="section-include-labels" class="heading-anchor_backwardsCompatibility"></div>Include Labels</div><a aria-label="Skip link to Include Labels" class="heading-anchor-icon fa fa-anchor" href="#include-labels"></a></h2> <p>When making requests to get survey responses, by default, the labels are not included. To include them, you just need to append &quot;&amp;include_labels=true&quot; with your request.</p> <p>For example:<br/> https://<span></span>api.smartsurvey.io/v/1/surveys/{surveyId}/responses/?<strong>include_labels=true</strong></p>" style="margin-left:31px" class="rm-Markdown markdown-body rm-Markdown markdown-body ng-non-bindable" data-testid="RDMD"><h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="api-basics"></div><div class="heading-text"><div id="section-api-basics" class="heading-anchor_backwardsCompatibility"></div>API Basics</div><a aria-label="Skip link to API Basics" class="heading-anchor-icon fa fa-anchor" href="#api-basics"></a></h2> <p>The SmartSurvey API gives you access to secure survey data for use in your own app. It strives to be RESTful and is organised around the main resources you’re familiar with from the SmartSurvey web interface.</p> <p>Before you do anything, you should make sure you have a SmartSurvey account that you can test the API against and register for an API key so that you can make API calls.</p> <p>The SmartSurvey API is a RESTful API, which adheres to the guidelines defined by REST. You can read more information about REST on the following link:<br/> <a target="_self" href="https://en.wikipedia.org/wiki/Representational_state_transfer#RESTful_web_services">https://en.wikipedia.org/wiki/Representational_state_transfer#RESTful_web_services</a></p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="getting-your-api-key"></div><div class="heading-text"><div id="section-getting-your-api-key" class="heading-anchor_backwardsCompatibility"></div>Getting Your API Key</div><a aria-label="Skip link to Getting Your API Key" class="heading-anchor-icon fa fa-anchor" href="#getting-your-api-key"></a></h2> <p>In order to use SmartSurvey API, you will need to request an API key from within your account dashboard. </p> <p>Follow the steps below to get your API key:</p> <ul> <li>Login to your account</li> <li>Click on My Account</li> <li>Click on API Keys</li> <li>Request API Access</li> <li>If you have not already requested one, click on request key.</li> <li>Click Add New API Key</li> <li>Once the key appears, use this to authenticate with the API</li> </ul> <p>If you do not see this option within your account, please <a target="_self" href="https://www.smartsurvey.co.uk/contact">contact us</a> for further assistance.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="authentication"></div><div class="heading-text"><div id="section-authentication" class="heading-anchor_backwardsCompatibility"></div>Authentication</div><a aria-label="Skip link to Authentication" class="heading-anchor-icon fa fa-anchor" href="#authentication"></a></h2> <p>Your API requests must use <a target="_self" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme">Basic Auth</a> for authentication. All API tooling should support this mechanism which should encode your api token and secret into a specific format, which is then passed in an HTTP header like this:</p> <p><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">Authorization: Basic <token></code></p> <p>You should not need to create this header manually, which is slightly complicated and which can cause various errors if not done correctly.</p> <p>Failed authentication will return an HTTP 401 Unauthorized response.</p> <p>Previously, we supported querystring parameters but these are now <em>deprecated</em> and all requests should switch to using Basic auth.</p> <p>E.g. <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">https://api.smartsurvey.io/v1/surveys?api_token=XXXXX&api_token_secret=XXXXX</code></p> <p>Note that if you are migrating to using Basic Auth, as soon as you provide an Authorization http header, the querystring parameters will be ignored even if they are correct. For this reason, a malformed Authorization header will cause a 401 even if you are still passing the querystring parameters.</p> <blockquote class="callout callout_warn" theme="🚧"><h2 class="callout-heading"><span class="callout-icon">🚧</span><p>Basic Auth, Usernames and Passwords</p></h2><p>Some Basic Auth examples and documentation, and the test function on the API refrerence pages, will refer to a "Username" and "Password". In the context of SmartSurvey API requests, "Username" is the API Token. "Password" is the Token Secret.</p><p>Do not try and use your SmartSurvey login credentials. This will not work, and will generate a 401 error.</p></blockquote> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="example-api-request"></div><div class="heading-text"><div id="section-example-api-request" class="heading-anchor_backwardsCompatibility"></div>Example API Request</div><a aria-label="Skip link to Example API Request" class="heading-anchor-icon fa fa-anchor" href="#example-api-request"></a></h2> <p><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">GET https://api.smartsurvey.io/v1/surveys</code></p> <p>In this example, the returned content will be inferred from the authenticated account i.e. you will get a list of all surveys linked to the authenticated account.</p> <p><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">GET https://api.smartsurvey.io/v1/surveys/12345</code></p> <p>In this example, when requesting a specific object (e.g. survey 12345), then if you are not permitted to access it with the authenticated account, you will receive am HTTP 403 Forbidden response.</p> <p>If using POST or PUT, you must use either application/json, text/xml or application/xml as the content-type for the request, with the body formatted accordingly otherwise you will receive a 415 error response.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="output-formats"></div><div class="heading-text"><div id="section-output-formats" class="heading-anchor_backwardsCompatibility"></div>Output Formats</div><a aria-label="Skip link to Output Formats" class="heading-anchor-icon fa fa-anchor" href="#output-formats"></a></h2> <p>The SmartSurvey API provides the output/response for an API request in the following<br/> formats.</p> <div class="rdmd-table"><div class="rdmd-table-inner"><table><thead><tr><th style="text-align:left">Format</th><th style="text-align:left">Accept Header</th></tr></thead><tbody><tr><td style="text-align:left"><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">JSON</code><br/><em>default</em></td><td style="text-align:left">application/json</td></tr><tr><td style="text-align:left"><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">XML</code></td><td style="text-align:left">application/xml</td></tr></tbody></table></div></div> <p>You can change the output format by providing an "Accept" request header with the above values.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="pagination"></div><div class="heading-text"><div id="section-pagination" class="heading-anchor_backwardsCompatibility"></div>Pagination</div><a aria-label="Skip link to Pagination" class="heading-anchor-icon fa fa-anchor" href="#pagination"></a></h2> <p>Some endpoints that return arrays support <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">page</code> and <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">page_size</code> as URL parameters. <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">page</code> defines the page index and <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">page_size</code> defines the number of records that will be returned on a page. The number of records is not guaranteed to be the number specified as visibility rules may filter out items. </p> <p><b>Query Parameters:</b></p> <ul> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">page</code> – page of records to return (defaults to 1)</li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">page_size</code> – number of records to return per page (defaults to 10, max is 100)<br/> If successful, you should receive the following custom headers in your response:</li> </ul> <p>For example:<br/> https://<span></span>api.smartsurvey.io/v/1/surveys/{surveyId}/responses/?<strong>page=1</strong>&<strong>page_size=100</strong></p> <div class="rdmd-table"><div class="rdmd-table-inner"><table><thead><tr><th style="text-align:left"></th><th style="text-align:left"></th></tr></thead><tbody><tr><td style="text-align:left"><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">X-SS-Pagination-Page</code></td><td style="text-align:left">The page number requested.</td></tr><tr><td style="text-align:left"><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">X-SS-Pagination-PageSize</code></td><td style="text-align:left">Number of rows requested.</td></tr><tr><td style="text-align:left"><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">X-SS-Pagination-Total</code></td><td style="text-align:left">The total number of rows found in database.</td></tr><tr><td style="text-align:left"><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">X-SS-Pagination-Returned</code></td><td style="text-align:left">The total number of rows returned.</td></tr></tbody></table></div></div> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="date-formats"></div><div class="heading-text"><div id="section-date-formats" class="heading-anchor_backwardsCompatibility"></div>Date Formats</div><a aria-label="Skip link to Date Formats" class="heading-anchor-icon fa fa-anchor" href="#date-formats"></a></h2> <p>NOTE: . </p> <p>Date-time information is always returned in UTC and ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). You will need to adjust the timezone to suit your needs.</p> <p>Dates sent to the API must be Unix epoch timestamp and should be formatted as shown in the example below: </p> <p>Example: Fri, 01 Jan 2016 00:00:00 UTC = 1451606400 (UTC Timestamp)</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="versioning"></div><div class="heading-text"><div id="section-versioning" class="heading-anchor_backwardsCompatibility"></div>Versioning</div><a aria-label="Skip link to Versioning" class="heading-anchor-icon fa fa-anchor" href="#versioning"></a></h2> <p>This REST API version v1 is our first API version. The API version is likely to change from v1 to vN {N = 1 …. n} if any structural changes are made to the existing version.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="security"></div><div class="heading-text"><div id="section-security" class="heading-anchor_backwardsCompatibility"></div>Security</div><a aria-label="Skip link to Security" class="heading-anchor-icon fa fa-anchor" href="#security"></a></h2> <p>All function calls included in SmartSurvey API are provided over https (Transport Layer Security). This ensures that your data is transmitted through a secure channel between our server and your client.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="include-labels"></div><div class="heading-text"><div id="section-include-labels" class="heading-anchor_backwardsCompatibility"></div>Include Labels</div><a aria-label="Skip link to Include Labels" class="heading-anchor-icon fa fa-anchor" href="#include-labels"></a></h2> <p>When making requests to get survey responses, by default, the labels are not included. To include them, you just need to append "&include_labels=true" with your request.</p> <p>For example:<br/> https://<span></span>api.smartsurvey.io/v/1/surveys/{surveyId}/responses/?<strong>include_labels=true</strong></p></div><div class="UpdatedAt"><p class="DateLine "><i class="icon icon-watch"></i>Updated<!-- --> <!-- -->about 2 years ago<!-- --> </p></div><hr class="NextStepsDivider"/><nav aria-label="Pagination Controls" class="PaginationControlsjDYuqu8pBMUy rm-Pagination"></nav></section><section class="content-toc grid-25"><nav><ul class="toc-list"><li><a class="tocHeader" href="#"><i class="icon icon-text-align-left"></i>Table of Contents</a></li><li class="toc-children"><ul> <li><a href="#api-basics">API Basics</a></li> <li><a href="#getting-your-api-key">Getting Your API Key</a></li> <li><a href="#authentication">Authentication</a></li> <li><a href="#example-api-request">Example API Request</a></li> <li><a href="#output-formats">Output Formats</a></li> <li><a href="#pagination">Pagination</a></li> <li><a href="#date-formats">Date Formats</a></li> <li><a href="#versioning">Versioning</a></li> <li><a href="#security">Security</a></li> <li><a href="#include-labels">Include Labels</a></li> </ul></li></ul></nav></section></div><div class="ModalWrapper" id="tutorialmodal-root"></div></article></div></main><footer aria-label="Status banner" class="AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div><div class="ng-non-bindable"><script id="ssr-props" data-initial-props="{"sidebars":{"docs":[{"_id":"573cdf70def24f0e008e585b","createdAt":"2016-05-18T21:32:32.394Z","slug":"documentation","title":"API","version":"573cdf70def24f0e008e585a","__v":0,"project":"573cdf70def24f0e008e5857","reference":false,"from_sync":false,"order":1,"pages":[{"_id":"573cdf70def24f0e008e585d","link_external":false,"slug":"getting-started","api":{"apiSetting":null,"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","method":"get"},"hidden":false,"isReference":false,"sync_unique":"","title":"Getting Started","type":"basic","category":"573cdf70def24f0e008e585b","createdAt":"2016-05-18T21:32:32.424Z","link_url":"","order":0,"parentDoc":null,"previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"573da9c1be576522007070e4","slug":"errors","hidden":false,"isReference":false,"link_url":"","order":1,"type":"basic","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"","apiSetting":null,"auth":"required","params":[],"method":"get"},"category":"573cdf70def24f0e008e585b","parentDoc":null,"link_external":false,"sync_unique":"","title":"Errors","createdAt":"2016-05-19T11:55:45.736Z","previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"573daa908ca48f320093ed8d","api":{"apiSetting":null,"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","method":"get"},"category":"573cdf70def24f0e008e585b","createdAt":"2016-05-19T11:59:12.295Z","sync_unique":"","type":"basic","link_external":false,"parentDoc":null,"hidden":false,"order":2,"slug":"rate-limiting","title":"Access & Rate Limiting","isReference":false,"link_url":"","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"57438bf0eed4ab0e00edc709","slug":"data-types","api":{"apiSetting":null,"auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","method":"get"},"createdAt":"2016-05-23T23:02:08.955Z","link_external":false,"parentDoc":null,"type":"basic","isReference":false,"order":4,"sync_unique":"","title":"Data Types","category":"573cdf70def24f0e008e585b","hidden":false,"link_url":"","previousSlug":"","isBodyEmpty":false,"children":[]}]},{"_id":"573d7f43e1ec4a2000e814a5","project":"573cdf70def24f0e008e5857","reference":false,"slug":"test","version":"573cdf70def24f0e008e585a","createdAt":"2016-05-19T08:54:27.868Z","from_sync":false,"order":2,"title":"WEB HOOKS","__v":0,"pages":[{"_id":"57444661f93b4b22009db9c7","category":"573d7f43e1ec4a2000e814a5","createdAt":"2016-05-24T12:17:37.500Z","isReference":false,"link_external":false,"order":0,"parentDoc":null,"sync_unique":"","slug":"webhooks-introduction","type":"basic","api":{"apiSetting":null,"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","method":"get"},"link_url":"","hidden":false,"title":"Introduction","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5760469f9b1a9a220067cb0f","title":"Samples","link_external":false,"order":1,"slug":"samples","sync_unique":"","hidden":false,"isReference":false,"link_url":"","parentDoc":null,"type":"basic","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"","apiSetting":null,"auth":"required"},"category":"573d7f43e1ec4a2000e814a5","createdAt":"2016-06-14T18:02:07.699Z","isBodyEmpty":false,"children":[]},{"_id":"576047059b1a9a220067cb15","link_url":"","order":2,"createdAt":"2016-06-14T18:03:49.297Z","hidden":false,"link_external":false,"parentDoc":null,"slug":"errors-1","sync_unique":"","title":"Errors","type":"basic","isReference":false,"category":"573d7f43e1ec4a2000e814a5","api":{"settings":"","url":"","apiSetting":null,"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"method":"get"},"deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":false,"children":[]}]}],"refs":[{"_id":"573ce6c947337f0e00b6d87c","from_sync":false,"order":1,"project":"573cdf70def24f0e008e5857","version":"573cdf70def24f0e008e585a","reference":true,"createdAt":"2016-05-18T22:03:53.556Z","slug":"objects","title":"SURVEYS","__v":0,"pages":[{"_id":"66b2161ab32cf90040b8d9bf","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Surveys","icon":"","type":"basic","slug":"surveys-1","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"573ce6c947337f0e00b6d87c","createdAt":"2024-08-06T12:24:58.823Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"573ce50da5de210e00875cf1","api":{"params":[{"in":"query","_id":"573ce50da5de210e00875cf3","ref":"","required":false,"desc":"Which page of surveys to return.","default":"1","type":"int","name":"page"},{"type":"int","in":"query","_id":"573ce50da5de210e00875cf2","default":"10","desc":"Number of surveys to return per page","name":"page_size","ref":"","required":false},{"default":"date_created,desc","type":"string","name":"sort_by","in":"query","_id":"573ce612df206d0e00b9d3b7","ref":"","required":false,"desc":"Field used to sort returned survey list: ‘id’, ‘title’, 'date_created’, or 'responses’. Add a comma and 'asc' or 'desc' to specify the sort order."},{"in":"query","_id":"573da6178ca48f320093ed86","default":"","desc":"You can add more than one sort_by to the querystring to sort by multiple fields.","name":"sort_by","ref":"","required":false,"type":"string"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n {\n \"id\": 123,\n \"type\": \"survey\",\n \"title\": \"My Fresh New Survey\",\n \"nickname\": \"\",\n \"date_created\": \"2016-05-30T00:51:14Z\",\n \"date_modified\": \"2016-05-30T01:10:38Z\",\n \"responses\": 0,\n \"status\": \"closed\",\n \"survey_url\": \"http://www.smartsurvey.co.uk/s/SF6VF/\",\n \"href\": \"https://api.smartsurvey.io/v1/surveys/223714\",\n \"href_responses\": \"https://api.smartsurvey.io/v1/surveys/223714/responses\"\n }\n]","name":""}]},"settings":"","url":"/surveys","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required","examples":{"codes":[]},"method":"get"},"createdAt":"2016-05-18T21:56:29.163Z","isReference":true,"link_url":"","slug":"surveys","title":"surveys","category":"573ce6c947337f0e00b6d87c","link_external":false,"sync_unique":"","order":0,"parentDoc":"66b2161ab32cf90040b8d9bf","type":"endpoint","hidden":false,"deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"573ce75747337f0e00b6d886","createdAt":"2016-05-18T22:06:15.878Z","hidden":false,"link_url":"","order":1,"title":"surveys/:survey_id","isReference":true,"parentDoc":"66b2161ab32cf90040b8d9bf","slug":"get-a-survey","sync_unique":"","type":"endpoint","api":{"url":"/surveys/:survey_id","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required","examples":{"codes":[]},"method":"get","params":[{"in":"path","name":"survey_id","ref":"","required":true,"type":"long","_id":"589c5b410552cc2f00a61cfc","default":"","desc":""}],"results":{"codes":[{"code":"{\n \"id\": 123,\n \"type\": \"survey\",\n \"title\": \"Customer Satisfaction\",\n \"nickname\": \"First Company Customer Satisfaction\",\n \"date_created\": \"2016-03-07T13:51:07Z\",\n \"date_modified\": \"2016-03-10T15:11:10Z\",\n \"responses\": 4479,\n \"status\": \"open\",\n \"survey_url\": \"http://www.smartsurvey.co.uk/s/123ABCDE/\",\n \"theme_id\": 3467,\n \"question_count\": 8,\n \"page_count\": 4,\n \"href\": \"https://api.smartsurvey.io/v1/surveys/550\",\n \"href_responses\": \"https://api.smartsurvey.io/v1/surveys/550/responses\"\n}","name":"","status":200,"language":"json"},{"status":404,"language":"json","code":"{\n \"status\": 404,\n \"code\": \"not_found\",\n \"message\": \"Survey with id '123' could not be found.\"\n}"}]},"settings":""},"category":"573ce6c947337f0e00b6d87c","link_external":false,"isBodyEmpty":true,"children":[]},{"_id":"574b974a90d8b320008648de","category":"573ce6c947337f0e00b6d87c","parentDoc":"66b2161ab32cf90040b8d9bf","sync_unique":"","title":"surveys/:survey_id/detailed","api":{"settings":"","url":"/surveys/:survey_id/detailed","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"589c5b4929523b23003ba1cf","ref":"","in":"path","required":true,"desc":"","default":"","type":"long","name":"survey_id"}],"results":{"codes":[{"name":"","code":"{\n \"id\": 123,\n \"type\": \"survey\",\n \"title\": \"Customer Satisfaction\",\n \"nickname\": \"First Company Customer Satisfaction\",\n \"date_created\": \"2016-03-07T13:51:07Z\",\n \"date_modified\": \"2016-03-10T15:11:10Z\",\n \"responses\": 999,\n \"status\": \"open\",\n \"survey_url\": \"http://www.smartsurvey.co.uk/s/123ABCDE/\",\n \"theme_id\": 3467,\n \"question_count\": 1,\n \"page_count\": 1,\n \"href\": \"https://api.smartsurvey.io/v1/surveys/123/detailed\",\n \"href_responses\": \"https://api.smartsurvey.io/v1/surveys/123/responses\",\n \"pages\": [\n {\n \"id\": 741653,\n \"title\": \"Contact Details\",\n \"position\": 1,\n \"questions\": [\n {\n \"id\": 3093118,\n \"title\": \"Please complete the following:\",\n \"position\": 1,\n \"choices\": [\n {\n \"id\": 341555070,\n \"choice_title\": \"First Name:\",\n \"choice_id\": 26099890,\n },\n {\n \"id\": 341555071,\n \"choice_title\": \"Surname:\",\n \"choice_id\": 26099891,\n \"value\": \"naser\"\n }\n ]\n }\n ]\n }\n ]\n}","language":"json","status":200}]}},"createdAt":"2016-05-30T01:28:42.284Z","order":2,"slug":"get-a-survey-detailed","hidden":false,"isReference":true,"link_external":false,"link_url":"","type":"endpoint","isBodyEmpty":true,"children":[]},{"_id":"574b94ac2aa7221700c51b87","createdAt":"2016-05-30T01:17:32.741Z","hidden":false,"isReference":true,"order":3,"parentDoc":"66b2161ab32cf90040b8d9bf","slug":"create-a-survey","category":"573ce6c947337f0e00b6d87c","sync_unique":"","api":{"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n \"id\": 123,\n \"type\": \"survey\",\n \"title\": \"Customer Satisfaction\",\n \"nickname\": \"First Company Customer Satisfaction\",\n \"date_created\": \"2016-03-07T13:51:07Z\",\n \"date_modified\": \"2016-03-10T15:11:10Z\",\n \"responses\": 999,\n \"status\": \"open\",\n \"survey_url\": \"http://www.smartsurvey.co.uk/s/123ABCDE/\",\n \"theme_id\": 3467,\n \"question_count\": 8,\n \"page_count\": 4,\n \"href\": \"https://api.smartsurvey.io/v1/surveys/550\",\n \"href_responses\": \"https://api.smartsurvey.io/v1/surveys/550/responses\"\n}"}]},"settings":"","url":"/surveys","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required","examples":{"codes":[]},"method":"post","params":[{"type":"string","in":"body","_id":"573ce50da5de210e00875cf2","default":"Copy of ...","desc":"Title of the new survey. Defaults to \"Copy of {SurveyTitle}\"","name":"title","ref":"","required":false},{"name":"language","ref":"","required":false,"type":"int","in":"body","_id":"573dd9cc1ad1a30e00a84e2b","default":"1","desc":"Survey language, defaults to 1 which is English. Check the <a href=\"/docs/data-types\">data types</a> for more information."},{"name":"theme_id","in":"body","_id":"574b94ac2aa7221700c51b88","ref":"","required":false,"desc":"The id of the theme. A default theme will be assigned if nothing is provided.","default":"0","type":"int"}]},"link_external":false,"title":"surveys","type":"endpoint","link_url":"","isBodyEmpty":true,"children":[]},{"_id":"573dd9427fe1642200f2a1bd","type":"endpoint","isReference":true,"parentDoc":"66b2161ab32cf90040b8d9bf","slug":"copy-a-survey","hidden":false,"title":"surveys/:survey_id","sync_unique":"","api":{"params":[{"name":"survey_id","type":"long","default":"","desc":"Survey id to copy from.","required":true,"in":"path","ref":"","_id":"573ce50da5de210e00875cf3"},{"name":"title","type":"string","default":"New Survey","desc":"Survey title","required":false,"in":"body","ref":"","_id":"573ce50da5de210e00875cf2"}],"results":{"codes":[{"name":"","code":"{\n \"id\": 123,\n \"type\": \"survey\",\n \"title\": \"Customer Satisfaction\",\n \"nickname\": \"First Company Customer Satisfaction\",\n \"date_created\": \"2016-03-07T13:51:07Z\",\n \"date_modified\": \"2016-03-10T15:11:10Z\",\n \"responses\": 999,\n \"status\": \"open\",\n \"survey_url\": \"http://www.smartsurvey.co.uk/s/123ABCDE/\",\n \"theme_id\": 3467,\n \"question_count\": 8,\n \"page_count\": 4,\n \"href\": \"https://api.smartsurvey.io/v1/surveys/550\",\n \"href_responses\": \"https://api.smartsurvey.io/v1/surveys/550/responses\"\n}","language":"json","status":200}]},"settings":"","url":"/surveys/:survey_id","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required","examples":{"codes":[]},"method":"put"},"createdAt":"2016-05-19T15:18:26.446Z","link_external":false,"order":4,"category":"573ce6c947337f0e00b6d87c","link_url":"","previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"574b91f59894551700515826","sync_unique":"","category":"573ce6c947337f0e00b6d87c","isReference":true,"link_external":false,"link_url":"","order":5,"parentDoc":"66b2161ab32cf90040b8d9bf","title":"surveys/:survey_id","api":{"params":[{"name":"survey_id","_id":"589c605eccb0c72500327ba8","ref":"","in":"path","required":true,"desc":"","default":"","type":"long"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"status\": 200,\n \"code\": \"success\",\n \"message\": \"Survey has been deleted.\"\n}","name":""},{"status":404,"language":"json","code":"{\n \"status\": 404,\n \"code\": \"not_found\",\n \"message\": \"Survey with id '123' could not be found or deleted.\"\n}"}]},"settings":"","url":"/surveys/:survey_id","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required","examples":{"codes":[]},"method":"delete"},"hidden":false,"slug":"delete-a-survey","createdAt":"2016-05-30T01:05:57.439Z","type":"endpoint","isBodyEmpty":true,"children":[]}]},{"_id":"66b216b1c034d600520ec473","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Responses","icon":"","type":"basic","slug":"responses","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"573ce6c947337f0e00b6d87c","createdAt":"2024-08-06T12:27:29.436Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"574446e99fb5d81900ab9920","parentDoc":"66b216b1c034d600520ec473","type":"endpoint","createdAt":"2016-05-24T12:19:53.599Z","isReference":true,"api":{"results":{"codes":[{"name":"","code":"[\n {\n \"id\": 12345,\n \"survey_id\": 12345,\n \"tracking_link_id\": 12345,\n \"translation_id\": 12345,\n \"date_started\": \"2016-05-30T15:53:10Z\",\n \"date_ended\": \"2016-05-30T15:53:24Z\",\n \"date_modified\": \"2016-05-30T15:53:24Z\",\n \"status\": \"completed\",\n \"contact_name\": \"test\",\n \"contact_email\": \"test@domain.com\",\n \"contact_invitation_id\": 12345,\n \"ip_address\": \"1.1.1.1\",\n \"user_agent\": \"Mozilla/5.0 (Windows NT 6.1; WOW64) Chrome/50.0.2661.102 Safari/537.36\",\n \"country\": \"0\",\n \"entry_url\": \"http://www.smartsurvey.co.uk/s/sample_survey/\",\n \"referer_url\": \"\",\n \"edit_url\": \"http://www.smartsurvey.co.uk/s/sample_survey/?uid=123&edit=abcdef\",\n \"saved\": false,\n \"saved_name\": \"\",\n \"saved_email\": \"\",\n \"saved_continue_url\": \"\",\n \"current_page_id\": 741654,\n \"manual_entry\": false,\n \"href\": \"https://api.smartsurvey.io/v1/surveys/12345/responses/12345\",\n \"contact_data\": [\n {\n \t\"name\" : \"dob\",\n \"value\" : \"02/03/1987\"\n }\n ],\n \"variables\": [\n {\n \"id\" : 10001,\n \t\"name\" : \"a\",\n \"label\" : \"Age\",\n \"value\" : \"30\"\n }\n ],\n \"pages\": [\n {\n \"id\": 12345,\n \"title\": \"Contact Details Page\",\n \"position\": 1,\n \"questions\": [\n {\n \"id\": 3093118,\n \"title\": \"Please complete the following:\",\n \"type\": \"open_ended\",\n \"sub_type\": \"multi\",\n \"position\": 1,\n \"answers\": [\n {\n \"id\": 380000354,\n \"type\": \"text\",\n \"choice_title\": \"First Name:\",\n \"choice_id\": 26099890,\n \"value\": \"John\"\n },\n {\n \"id\": 380000355,\n \"type\": \"text\",\n \"choice_title\": \"Surname:\",\n \"choice_id\": 26099891,\n \"value\": \"Smith\"\n }\n ]\n }\n ]\n }\n ]\n }\n]","language":"json","status":200}]},"settings":"","url":"/surveys/:survey_id/responses","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"completed","type":"int","default":"1","desc":"0=Partial, 1=Completed, 2=Both - Return completed responses or partial.","required":false,"in":"query","ref":"","_id":"574447a1e42a590e00e2703f"},{"name":"since","type":"long","default":"0","desc":"Return responses that completed no earlier than this Unix epoch timestamp","required":false,"in":"query","ref":"","_id":"574447a1e42a590e00e2703d"},{"name":"until","type":"long","default":"0","desc":"Return responses that completed no later than this Unix epoch timestamp","required":false,"in":"query","ref":"","_id":"574447a1e42a590e00e2703c"},{"name":"filter_id","type":"long","default":"0","desc":"Enter the filter report ID you would like to use. Other filters will be ignored.","required":false,"in":"query","ref":"","_id":"574447a1e42a590e00e2703b"},{"name":"tracking_link_id","type":"long","default":"","desc":"Filter by tracking link id","required":false,"in":"query","ref":"","_id":"577a8684b7ee4a0e007c4c49"},{"name":"unique_id","type":"string","default":"","desc":"Filter the unique (x) value","required":false,"in":"query","ref":"","_id":"577a8684b7ee4a0e007c4c48"},{"name":"include_labels","type":"boolean","default":"false","desc":"Return text of page/question/choice labels, rather than indices only","required":false,"in":"query","ref":"","_id":"57462e3004f2410e00a5a30e"},{"name":"page","type":"int","default":"1","desc":"Which page to return.","required":false,"in":"query","ref":"","_id":"573ce50da5de210e00875cf3"},{"name":"page_size","type":"int","default":"10","desc":"Number of rows to return per page","required":false,"in":"query","ref":"","_id":"573ce50da5de210e00875cf2"},{"name":"sort_by","type":"string","default":"date_ended,desc","desc":"Field used to sort returned survey list: ‘date_started’, ‘date_ended’ or 'date_modified’. Add a comma and 'asc' or 'desc' to specify the sort order.","required":false,"in":"query","ref":"","_id":"573ce612df206d0e00b9d3b7"},{"name":"sort_by","type":"string","default":"","desc":"You can add more than one sort_by to the querystring to sort by multiple fields.","required":false,"in":"query","ref":"","_id":"573da6178ca48f320093ed86"},{"name":"survey_id","type":"long","default":"","desc":"","required":true,"in":"path","ref":"","_id":"589c602f8912591b00fd955c"}],"apiSetting":"58b53b0d1065f9c438aa1adb"},"hidden":false,"link_external":false,"link_url":"","order":0,"slug":"get-responses","sync_unique":"","category":"573ce6c947337f0e00b6d87c","title":"responses","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"574b973d2aa7221700c51b8b","hidden":false,"link_url":"","order":1,"slug":"get-a-response","link_external":false,"sync_unique":"","title":"responses/:response_id","api":{"url":"/surveys/:survey_id/responses/:response_id","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"survey_id","ref":"","required":true,"type":"long","_id":"589c6039ccb0c72500327ba4","default":"","desc":"","in":"path"},{"_id":"589c5b350552cc2f00a61cfb","default":"","desc":"","in":"path","name":"response_id","ref":"","required":true,"type":"long"},{"name":"include_labels","_id":"574c7c7f5953e20e00f40f28","ref":"","in":"query","required":false,"desc":"Return text of page/question/choice labels and types, rather than indices only","default":"true","type":"boolean"}],"results":{"codes":[{"name":"","code":"{\n \"id\": 12345,\n \"survey_id\": 12345,\n \"tracking_link_id\": 12345,\n \"translation_id\": 12345,\n \"date_started\": \"2016-05-30T15:53:10Z\",\n \"date_ended\": \"2016-05-30T15:53:24Z\",\n \"date_modified\": \"2016-05-30T15:53:24Z\",\n \"status\": \"completed\",\n \"contact_name\": \"\",\n \"contact_email\": \"\",\n \"contact_invitation_id\": 0,\n \"ip_address\": \"::1\",\n \"user_agent\": \"Mozilla/5.0 (Windows NT 6.1; WOW64) Chrome/50.0.2661.102 Safari/537.36\",\n \"country\": \"0\",\n \"entry_url\": \"http://www.smartsurvey.co.uk/s/sample_survey/\",\n \"referer_url\": \"\",\n \"edit_url\": \"http://www.smartsurvey.co.uk/s/sample_survey/?uid=123&edit=abcdef\",\n \"saved\": false,\n \"saved_name\": \"\",\n \"saved_email\": \"\",\n \"saved_continue_url\": \"\",\n \"current_page_id\": 741654,\n \"manual_entry\": false,\n \"href\": \"https://api.smartsurvey.io/v1/surveys/12345/responses/12345\",\n \"pages\": [\n {\n \"id\": 12345,\n \"title\": \"Contact Details Page\",\n \"position\": 1,\n \"questions\": [\n {\n \"id\": 3093118,\n \"title\": \"Please complete the following:\",\n \"type\": \"open_ended\",\n \"sub_type\": \"multi\",\n \"position\": 1,\n \"answers\": [\n {\n \"id\": 380000354,\n \"type\": \"text\",\n \"choice_title\": \"First Name:\",\n \"choice_id\": 26099890,\n \"value\": \"John\"\n },\n {\n \"id\": 380000355,\n \"type\": \"text\",\n \"choice_title\": \"Surname:\",\n \"choice_id\": 26099891,\n \"value\": \"Smith\"\n }\n ]\n }\n ]\n }\n ]\n}","language":"json","status":200}]},"settings":""},"category":"573ce6c947337f0e00b6d87c","createdAt":"2016-05-30T01:28:29.866Z","isReference":true,"parentDoc":"66b216b1c034d600520ec473","type":"endpoint","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"574c5defa1f0be2000ae3729","slug":"delete-a-response","sync_unique":"","title":"responses/:response_id","isReference":true,"link_url":"","parentDoc":"66b216b1c034d600520ec473","createdAt":"2016-05-30T15:36:15.255Z","link_external":false,"hidden":false,"type":"endpoint","api":{"auth":"required","examples":{"codes":[]},"method":"delete","params":[{"name":"survey_id","ref":"","required":true,"type":"long","_id":"589c60480552cc2f00a61d05","default":"","desc":"","in":"path"},{"type":"long","_id":"589c60480552cc2f00a61d04","default":"","desc":"","in":"path","name":"response_id","ref":"","required":true}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"status\": 200,\n \"code\": \"success\",\n \"message\": \"Survey response has been deleted.\"\n}","name":""},{"status":404,"language":"json","code":"{\n \"status\": 404,\n \"code\": \"not_found\",\n \"message\": \"Response with id '123' could not be found or deleted.\"\n}"}]},"settings":"","url":"/surveys/:survey_id/responses/:response_id","apiSetting":"58b53b0d1065f9c438aa1adb"},"category":"573ce6c947337f0e00b6d87c","order":2,"deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]}]},{"_id":"66b216d5501830000ff2157d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Tracking Links","icon":"","type":"basic","slug":"tracking-links","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"573ce6c947337f0e00b6d87c","createdAt":"2024-08-06T12:28:05.899Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"574c89765953e20e00f40f39","link_url":"","api":{"results":{"codes":[{"code":"[\n {\n \"id\": 123,\n \"type\": \"web_link\",\n \"title\": \"Default Web Link\",\n \"status\": \"open\",\n \"responses\": 999,\n \"date_created\": \"2016-03-07T13:51:07Z\",\n \"date_modified\": \"2016-03-07T13:51:07Z\",\n \"survey_url\": \"http://www.smartsurvey.co.uk/s/sample_survey/\",\n \"href\": \"https://api.smartsurvey.io/v1/surveys/550/links/123\"\n }\n]","name":"","status":200,"language":"json"}]},"settings":"","url":"/surveys/:survey_id/links","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required","examples":{"codes":[]},"method":"get","params":[{"required":true,"type":"long","_id":"589c5fdd8912591b00fd955a","default":"","desc":"","in":"path","name":"survey_id","ref":""}]},"hidden":false,"isReference":true,"slug":"links","link_external":false,"type":"endpoint","category":"573ce6c947337f0e00b6d87c","parentDoc":"66b216d5501830000ff2157d","title":"links","sync_unique":"","createdAt":"2016-05-30T18:41:58.943Z","order":0,"deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"574c8b756f075519007da10a","createdAt":"2016-05-30T18:50:29.690Z","isReference":true,"parentDoc":"66b216d5501830000ff2157d","link_external":false,"title":"links/:link_id","api":{"examples":{"codes":[]},"method":"get","params":[{"_id":"589c608cccb0c72500327baa","ref":"","in":"path","required":true,"desc":"","default":"","type":"long","name":"survey_id"},{"name":"link_id","_id":"589c608cccb0c72500327ba9","ref":"","in":"path","required":true,"desc":"","default":"","type":"long"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 123,\n \"type\": \"web_link\",\n \"title\": \"Default Web Link\",\n \"status\": \"open\",\n \"responses\": 999,\n \"date_created\": \"2016-03-07T13:51:07Z\",\n \"date_modified\": \"2016-03-07T13:51:07Z\",\n \"survey_url\": \"http://www.smartsurvey.co.uk/s/sample_survey/\",\n \"href\": \"https://api.smartsurvey.io/v1/surveys/550/links/123\"\n}","name":""},{"status":404,"language":"json","code":"{\n \"status\": 404,\n \"code\": \"not_found\",\n \"message\": \"Survey with id '{surveyId}' could not be found or tracking link with id '{trackingLinkId}' could not be found.\"\n}"}]},"settings":"","url":"/surveys/:survey_id/links/:link_id","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required"},"type":"endpoint","link_url":"","slug":"get-a-link","hidden":false,"order":1,"sync_unique":"","category":"573ce6c947337f0e00b6d87c","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"574c8cf96f075519007da10c","category":"573ce6c947337f0e00b6d87c","createdAt":"2016-05-30T18:56:57.136Z","link_url":"","order":2,"parentDoc":"66b216d5501830000ff2157d","sync_unique":"","link_external":false,"slug":"create-a-link","hidden":false,"title":"links","type":"endpoint","api":{"auth":"required","examples":{"codes":[]},"method":"post","params":[{"_id":"589c609e0552cc2f00a61d07","ref":"","in":"path","required":true,"desc":"","default":"","type":"long","name":"survey_id"},{"_id":"5b7c37d70dc2e20003871780","ref":"","in":"query","required":false,"desc":"If left blank, a title based on the type of link will be generated.","default":"","type":"string","name":"title"},{"_id":"5b7c37d70dc2e2000387177f","ref":"","in":"query","required":false,"desc":"The tracking link type. See <a href=\"/docs/data-types\">data types</a> for enum values. Defaults to standard web link.","default":"2","type":"int","name":"type"}],"results":{"codes":[{"language":"json","code":"{\n \"id\": 123,\n \"type\": \"web_link\",\n \"title\": \"Default Web Link\",\n \"status\": \"open\",\n \"responses\": 999,\n \"date_created\": \"2016-03-07T13:51:07Z\",\n \"date_modified\": \"2016-03-07T13:51:07Z\",\n \"survey_url\": \"http://www.smartsurvey.co.uk/s/sample_survey/\",\n \"href\": \"https://api.smartsurvey.io/v1/surveys/550/links/123\"\n}","name":"","status":200}]},"settings":"","url":"/surveys/:survey_id/links/","apiSetting":"58b53b0d1065f9c438aa1adb"},"isReference":true,"deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"574c8e40281b010e0000906f","category":"573ce6c947337f0e00b6d87c","parentDoc":"66b216d5501830000ff2157d","link_external":false,"link_url":"","order":3,"slug":"copy-a-link","sync_unique":"","type":"endpoint","hidden":false,"api":{"settings":"","url":"/surveys/:survey_id/links/:link_id","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required","examples":{"codes":[]},"method":"put","params":[{"name":"survey_id","type":"long","enumValues":"","default":"","desc":"","required":true,"in":"path","ref":"","_id":"589c60afccb0c72500327bac"},{"name":"link_id","type":"long","enumValues":"","default":"","desc":"","required":true,"in":"path","ref":"","_id":"589c60afccb0c72500327bab"},{"name":"title","type":"string","enumValues":"","default":"","desc":"If left blank, a title based on the type of link will be generated.","required":false,"in":"query","ref":"","_id":"62d09bbc11399f00a2a18594"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n \"id\": 123,\n \"type\": \"web_link\",\n \"title\": \"Web Link 2\",\n \"status\": \"open\",\n \"responses\": 999,\n \"date_created\": \"2016-03-07T13:51:07Z\",\n \"date_modified\": \"2016-03-07T13:51:07Z\",\n \"survey_url\": \"http://www.smartsurvey.co.uk/s/sample_survey/\",\n \"href\": \"https://api.smartsurvey.io/v1/surveys/550/links/123\"\n}"}]}},"createdAt":"2016-05-30T19:02:24.044Z","isReference":true,"title":"links/:link_id","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":true,"children":[]},{"_id":"627bd3da8fe0bb0013d0a92d","api":{"method":"put","url":"/surveys/:survey_id/links/:link_id/open","auth":"required","settings":"","apiSetting":"58b53b0d1065f9c438aa1adb","examples":{"codes":[]},"params":[{"name":"survey_id","type":"long","enumValues":"","default":"","desc":"","required":true,"in":"path","ref":"","_id":"589c60afccb0c72500327bac"},{"name":"link_id","type":"long","enumValues":"","default":"","desc":"","required":true,"in":"path","ref":"","_id":"589c60afccb0c72500327bab"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n \"status\": 200,\n \"code\": \"success\",\n \"message\": \"Tracking link has now been opened.\"\n}"}]}},"title":"links/:link_id/open","type":"endpoint","slug":"open-a-link","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"links-link_id-open","createdAt":"2022-05-11T15:18:50.476Z","category":"573ce6c947337f0e00b6d87c","parentDoc":"66b216d5501830000ff2157d","icon":"","isBodyEmpty":true,"children":[]},{"_id":"627bd65949c095009b5b96c4","api":{"method":"put","url":"/surveys/:survey_id/links/:link_id/close","auth":"required","settings":"","apiSetting":"58b53b0d1065f9c438aa1adb","examples":{"codes":[]},"params":[{"name":"survey_id","type":"long","enumValues":"","default":"","desc":"","required":true,"in":"path","ref":"","_id":"589c60afccb0c72500327bac"},{"name":"link_id","type":"long","enumValues":"","default":"","desc":"","required":true,"in":"path","ref":"","_id":"589c60afccb0c72500327bab"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n \"status\": 200,\n \"code\": \"success\",\n \"message\": \"Tracking link has now been closed.\"\n}"}]}},"title":"links/:link_id/close","type":"endpoint","slug":"close-a-link","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"links-link_id-close","createdAt":"2022-05-11T15:29:29.353Z","category":"573ce6c947337f0e00b6d87c","parentDoc":"66b216d5501830000ff2157d","icon":"","isBodyEmpty":true,"children":[]},{"_id":"574c8be6a1f0be2000ae3761","createdAt":"2016-05-30T18:52:22.333Z","sync_unique":"","type":"endpoint","category":"573ce6c947337f0e00b6d87c","api":{"examples":{"codes":[]},"method":"delete","params":[{"type":"long","name":"survey_id","_id":"589c60c08912591b00fd955f","ref":"","in":"path","required":true,"desc":"","default":""},{"required":true,"desc":"","default":"","type":"long","name":"link_id","_id":"589c60c08912591b00fd955e","ref":"","in":"path"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n \"status\": 200,\n \"code\": \"success\",\n \"message\": \"Tracking link has been deleted.\"\n}"},{"status":404,"language":"json","code":"{\n \"status\": 404,\n \"code\": \"not_found\",\n \"message\": \"Tracking link with id '123' could not be found or deleted.\"\n}"}]},"settings":"","url":"/surveys/:survey_id/links/:link_id","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required"},"isReference":true,"order":6,"hidden":false,"link_url":"","title":"links/:link_id","parentDoc":"66b216d5501830000ff2157d","slug":"delete-a-link","link_external":false,"deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]}]},{"_id":"66b216f9b32cf90040b8d9dc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Exports","icon":"","type":"basic","slug":"exports","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"573ce6c947337f0e00b6d87c","createdAt":"2024-08-06T12:28:41.965Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5a70a9f7ac92c3003d38ecca","category":"573ce6c947337f0e00b6d87c","createdAt":"2018-01-30T17:23:03.932Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"apiSetting":"58b53b0d1065f9c438aa1adb","settings":"","results":{"codes":[{"code":"[\n {\n \"id\": 56789,\n \"name\": \"All survey responses\",\n \"status\": \"completed\",\n \"type\": \"Raw Data (.xlsx)\",\n \"file_extension\": \".xlsx\",\n \"file_size\": 178306,\n \"file_content_type\": \"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\",\n \"date_requested\": \"2018-01-30T11:22:29Z\",\n \"date_started\": \"2018-01-30T12:09:31Z\",\n \"date_completed\": \"2018-01-30T12:09:39Z\",\n \"href\": \"https://api.smartsurvey.io/v1/surveys/123/exports/56789\",\n \"href_download\": \"https://api.smartsurvey.io/v1/surveys/1234/exports/56789/download\"\n }\n]","name":"","status":200,"language":"json"}]},"auth":"required","params":[{"_id":"589c5fdd8912591b00fd955a","ref":"","in":"path","required":true,"desc":"","default":"","type":"long","name":"survey_id"}],"url":"/surveys/:survey_id/exports","method":"get"},"isReference":true,"order":0,"slug":"survey_report_exports","type":"endpoint","title":"exports","parentDoc":"66b216f9b32cf90040b8d9dc","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"5a70aac8532a820012ce89ff","category":"573ce6c947337f0e00b6d87c","createdAt":"2018-01-30T17:26:32.399Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"{\n \"id\": 56789,\n \"name\": \"All survey responses\",\n \"status\": \"completed\",\n \"type\": \"Raw Data (.xlsx)\",\n \"file_extension\": \".xlsx\",\n \"file_size\": 178306,\n \"file_content_type\": \"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\",\n \"date_requested\": \"2018-01-30T11:22:29Z\",\n \"date_started\": \"2018-01-30T12:09:31Z\",\n \"date_completed\": \"2018-01-30T12:09:39Z\",\n \"href\": \"https://api.smartsurvey.io/v1/surveys/123/exports/56789\",\n \"href_download\": \"https://api.smartsurvey.io/v1/surveys/1234/exports/56789/download\"\n}","name":"","status":200,"language":"json"}]},"settings":"","apiSetting":"58b53b0d1065f9c438aa1adb","examples":{"codes":[]},"auth":"required","params":[{"name":"survey_id","type":"long","default":"","desc":"","required":true,"in":"path","ref":"","_id":"589c5fdd8912591b00fd955a"},{"name":"export_id","type":"long","default":"","desc":"","required":false,"in":"path","ref":"","_id":"5a70aac8532a820012ce8a00"}],"url":"/surveys/:survey_id/exports/:export_id","method":"get"},"isReference":true,"order":1,"slug":"exportsexport_id","type":"endpoint","title":"exports/:export_id","parentDoc":"66b216f9b32cf90040b8d9dc","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":true,"children":[]},{"_id":"5a70abda96b0e3001276b5d3","category":"573ce6c947337f0e00b6d87c","createdAt":"2018-01-30T17:31:06.264Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53b0d1065f9c438aa1adb","settings":"","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n \"status\": 200,\n \"code\": \"success\",\n \"message\": \"Export report has been deleted.\"\n}"},{"status":404,"language":"json","code":"{\n \"status\": 404,\n \"code\": \"not_found\",\n \"message\": \"Tracking link with id '123' could not be found or deleted.\"\n}"}]},"examples":{"codes":[]},"auth":"required","params":[{"name":"survey_id","type":"long","default":"","desc":"","required":true,"in":"path","ref":"","_id":"589c60c08912591b00fd955f"},{"name":"export_id","type":"long","default":"","desc":"","required":true,"in":"path","ref":"","_id":"589c60c08912591b00fd955e"}],"url":"/surveys/:survey_id/exports/:export_id","method":"delete"},"isReference":true,"order":2,"slug":"delete_survey_report_export","type":"endpoint","title":"exports/:export_id","parentDoc":"66b216f9b32cf90040b8d9dc","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":true,"children":[]},{"_id":"5a70ab47200111004c862b28","category":"573ce6c947337f0e00b6d87c","createdAt":"2018-01-30T17:28:39.869Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"apiSetting":"58b53b0d1065f9c438aa1adb","settings":"","results":{"codes":[{"code":"\"UserID\",\"UserNo\",\"Name\",\"Email\",\"IP Address\",\"Unique ID\",\"Started\",\"Ended\",\"Tracking Link\",\"Q1. Please select your gender:\"\n\"859764\",\"1\",\"\",\"\",\"1.1.1.1\",\"\",\"27/07/2009 09:28:00\",\"27/07/2009 09:30:00\",\"Default Web Link\",\"Male\"\n\"859765\",\"1\",\"\",\"\",\"1.1.1.1\",\"\",\"27/06/2009 09:28:00\",\"27/07/2009 09:30:00\",\"Default Web Link\",\"Female\"","name":"","status":200,"language":"text"}]},"auth":"required","params":[{"name":"survey_id","type":"long","default":"","desc":"","required":true,"in":"path","ref":"","_id":"589c5fdd8912591b00fd955a"},{"name":"export_id","type":"long","default":"","desc":"","required":false,"in":"path","ref":"","_id":"5a70aac8532a820012ce8a00"}],"url":"/surveys/:survey_id/exports/:export_id/download","method":"get"},"isReference":true,"order":3,"slug":"download_survey_report_exports","type":"endpoint","title":"exports/:export_id/download","parentDoc":"66b216f9b32cf90040b8d9dc","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"62543f1b93a5f902fa388d7f","api":{"method":"get","url":"/surveys/:survey_id/exports/latest/download","auth":"required","examples":{"codes":[]},"apiSetting":"58b53b0d1065f9c438aa1adb","settings":"","results":{"codes":[{"code":"\"UserID\",\"UserNo\",\"Name\",\"Email\",\"IP Address\",\"Unique ID\",\"Started\",\"Ended\",\"Tracking Link\",\"Q1. Please select your gender:\"\n\"859764\",\"1\",\"\",\"\",\"1.1.1.1\",\"\",\"27/07/2009 09:28:00\",\"27/07/2009 09:30:00\",\"Default Web Link\",\"Male\"\n\"859765\",\"1\",\"\",\"\",\"1.1.1.1\",\"\",\"27/06/2009 09:28:00\",\"27/07/2009 09:30:00\",\"Default Web Link\",\"Female\"","name":"","status":200,"language":"text"}]},"params":[{"name":"survey_id","type":"long","enumValues":"","default":"","desc":"","required":true,"in":"path","ref":"","_id":"589c5fdd8912591b00fd955a"}]},"title":"exports/latest/download","type":"endpoint","slug":"exportslatestdownload","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-11T14:45:47.222Z","category":"573ce6c947337f0e00b6d87c","parentDoc":"66b216f9b32cf90040b8d9dc","icon":"","isBodyEmpty":false,"children":[]},{"_id":"625440659ea175007705dfb6","api":{"method":"get","url":"/surveys/:survey_id/exports/latest/download/{report_type}","auth":"required","examples":{"codes":[]},"apiSetting":"58b53b0d1065f9c438aa1adb","settings":"","results":{"codes":[{"code":"\"UserID\",\"UserNo\",\"Name\",\"Email\",\"IP Address\",\"Unique ID\",\"Started\",\"Ended\",\"Tracking Link\",\"Q1. Please select your gender:\"\n\"859764\",\"1\",\"\",\"\",\"1.1.1.1\",\"\",\"27/07/2009 09:28:00\",\"27/07/2009 09:30:00\",\"Default Web Link\",\"Male\"\n\"859765\",\"1\",\"\",\"\",\"1.1.1.1\",\"\",\"27/06/2009 09:28:00\",\"27/07/2009 09:30:00\",\"Default Web Link\",\"Female\"","name":"","status":200,"language":"text"}]},"params":[{"name":"survey_id","type":"long","enumValues":"","default":"","desc":"","required":true,"in":"path","ref":"","_id":"589c5fdd8912591b00fd955a"},{"name":"report_type","type":"int","enumValues":"","default":"","desc":"Specify the type you wish to download the latest report for","required":false,"in":"path","ref":"","_id":"625440659ea175007705dfb7"}]},"title":"exports/latest/download/{report_type}","type":"endpoint","slug":"exportslatestdownloadreport_type","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-11T14:51:17.699Z","category":"573ce6c947337f0e00b6d87c","parentDoc":"66b216f9b32cf90040b8d9dc","icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"66b217442ecf960059e64d20","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Survey Folders","icon":"","type":"basic","slug":"survey-folders","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"573ce6c947337f0e00b6d87c","createdAt":"2024-08-06T12:29:56.530Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"589c5a1cccb0c72500327b99","category":"573ce6c947337f0e00b6d87c","parentDoc":"66b217442ecf960059e64d20","title":"surveyfolders","slug":"surveyfolders","api":{"url":"/surveyfolders","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n {\n \"id\": 1234,\n \"type\": \"survey_folder\",\n \"title\": \"My Survey Folder\",\n \"href\": \"https://api.smartsurvey.io/v1/surveyfolders/1234\"\n }\n]","name":""}]},"settings":""},"createdAt":"2017-02-09T12:01:32.251Z","link_external":false,"link_url":"","order":0,"isReference":true,"hidden":false,"sync_unique":"","type":"endpoint","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"589c5a6d29523b23003ba1ce","hidden":false,"title":"surveyfolders/:folder_id","api":{"method":"get","params":[{"default":"","desc":"","in":"path","name":"folder_id","ref":"","required":true,"type":"int","_id":"589c5b07ccb0c72500327b9e"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 1234,\n \"type\": \"survey_folder\",\n \"title\": \"My Survey Folder\",\n \"href\": \"https://api.smartsurvey.io/v1/surveyfolders/1234\"\n}","name":""}]},"settings":"","url":"/surveyfolders/:folder_id","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required","examples":{"codes":[]}},"createdAt":"2017-02-09T12:02:53.698Z","parentDoc":"66b217442ecf960059e64d20","slug":"surveyfoldersfolder_id","sync_unique":"","order":1,"category":"573ce6c947337f0e00b6d87c","type":"endpoint","link_url":"","isReference":true,"link_external":false,"deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"589c5ac58912591b00fd954d","title":"surveyfolders/:folder_id/detailed","category":"573ce6c947337f0e00b6d87c","slug":"surveyfoldersfolder_iddetailed","sync_unique":"","type":"endpoint","hidden":false,"link_url":"","parentDoc":"66b217442ecf960059e64d20","createdAt":"2017-02-09T12:04:21.567Z","isReference":true,"link_external":false,"api":{"params":[{"name":"folder_id","_id":"589c60ce8912591b00fd9560","ref":"","in":"path","required":true,"desc":"","default":"","type":"long"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 1234,\n \"type\": \"survey_folder\",\n \"title\": \"My Survey Folder\",\n \"href\": \"https://api.smartsurvey.io/v1/surveyfolders/1234\",\n \"surveys\": [\n {\n \"id\": 987,\n \"type\": \"survey\",\n \"title\": \"Survey Template\",\n \"nickname\": \"\",\n \"date_created\": \"2010-02-11T17:09:41Z\",\n \"date_modified\": \"2010-02-11T17:09:41Z\",\n \"responses\": 541,\n \"status\": \"open\",\n \"href\": \"https://api.smartsurvey.io/v1/surveys/987\"\n }\n ]\n}","name":""}]},"settings":"","url":"/surveyfolders/:folder_id/detailed","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required","examples":{"codes":[]},"method":"get"},"order":2,"deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]}]}]},{"_id":"5a0cd760ddd9be00123df492","project":"573cdf70def24f0e008e5857","version":"573cdf70def24f0e008e585a","isAPI":false,"reference":true,"createdAt":"2017-11-16T00:10:08.784Z","from_sync":false,"order":2,"slug":"account","title":"ACCOUNT","__v":0,"pages":[{"_id":"66b21762bdbd0600559fc925","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Account","icon":"","type":"basic","slug":"account-1","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5a0cd760ddd9be00123df492","createdAt":"2024-08-06T12:30:26.842Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5a0cd775d798240012fef4ff","category":"5a0cd760ddd9be00123df492","createdAt":"2017-11-16T00:10:29.346Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53b0d1065f9c438aa1adb","settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 123,\n \"type\": \"account_user\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"fullname\": \"John Smith\",\n \"email\": \"john.smith@domain.com\",\n \"date_created\": \"2017-03-06T12:45:58Z\",\n \"surveys\": 27,\n \"href\": \"https://api.smartsurvey.io/v1/accountusers/123\"\n}","name":""}]},"examples":{"codes":[]},"auth":"required","params":[],"url":"/account","method":"get"},"isReference":true,"order":0,"slug":"account","type":"endpoint","title":"account","parentDoc":"66b21762bdbd0600559fc925","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]}]},{"_id":"66b217a842125e00248c6d24","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Account Users","icon":"","type":"basic","slug":"account-users","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5a0cd760ddd9be00123df492","createdAt":"2024-08-06T12:31:36.435Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"58ece351dbdd4e2500ae1b76","link_external":false,"slug":"accountusers","api":{"examples":{"codes":[]},"apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required","params":[],"url":"/accountusers","method":"get","settings":"","results":{"codes":[{"status":200,"language":"json","code":"[\n {\n \"id\": 123,\n \"type\": \"account_user\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"fullname\": \"John Smith\",\n \"email\": \"john.smith@domain.com\",\n \"date_created\": \"2017-03-06T12:45:58Z\",\n \"surveys\": 27,\n \"href\": \"https://api.smartsurvey.io/v1/accountusers/123\"\n }\n]","name":""}]}},"isReference":true,"link_url":"","order":0,"parentDoc":"66b217a842125e00248c6d24","title":"accountusers","category":"5a0cd760ddd9be00123df492","createdAt":"2017-04-11T14:08:17.130Z","hidden":false,"sync_unique":"","type":"endpoint","isBodyEmpty":true,"children":[]},{"_id":"58ece385212cd92d002b1f51","slug":"accountusersuser_id","title":"accountusers/:account_user_id","link_url":"","order":1,"type":"endpoint","link_external":false,"parentDoc":"66b217a842125e00248c6d24","category":"5a0cd760ddd9be00123df492","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"589c5b07ccb0c72500327b9e","ref":"","in":"path","required":true,"desc":"","default":"","type":"long","name":"account_user_id"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 123,\n \"type\": \"account_user\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"fullname\": \"John Smith\",\n \"email\": \"john.smith@domain.com\",\n \"date_created\": \"2017-03-06T12:45:58Z\",\n \"surveys\": 27,\n \"href\": \"https://api.smartsurvey.io/v1/accountusers/123\"\n}","name":""}]},"settings":"","url":"/accountusers/:account_user_id","apiSetting":"58b53b0d1065f9c438aa1adb"},"createdAt":"2017-04-11T14:09:09.864Z","hidden":false,"isReference":true,"sync_unique":"","isBodyEmpty":true,"children":[]}]},{"_id":"66b217731318ca0024ab925a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Contact Lists","icon":"","type":"basic","slug":"contact-lists","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5a0cd760ddd9be00123df492","createdAt":"2024-08-06T12:30:43.647Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5a03279a3b06f2001ce700c9","category":"5a0cd760ddd9be00123df492","createdAt":"2017-11-08T15:49:46.022Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n {\n \"id\": 123,\n \"type\": \"email\",\n \"title\": \"Sample Contact List\",\n \"date_created\": \"2017-10-27T15:07:01Z\",\n \"contacts\": 5325,\n \"href\": \"https://api.smartsurvey.io/v1/contactlists/123\"\n }\n]","name":""}]},"settings":"","apiSetting":"58b53b0d1065f9c438aa1adb","examples":{"codes":[]},"auth":"required","params":[],"url":"/contactlists","method":"get"},"isReference":true,"order":0,"slug":"contactlists","type":"endpoint","title":"contactlists","parentDoc":"66b217731318ca0024ab925a","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"5a03285e4bd2620010a4d4f7","category":"5a0cd760ddd9be00123df492","createdAt":"2017-11-08T15:53:02.711Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"apiSetting":"58b53b0d1065f9c438aa1adb","settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 123,\n \"type\": \"email\",\n \"title\": \"Sample Contact List\",\n \"date_created\": \"2017-10-27T15:07:01Z\",\n \"contacts\": 5325,\n \"href\": \"https://api.smartsurvey.io/v1/contactlists/123\"\n}","name":""}]},"auth":"required","params":[{"name":"contact_list_id","type":"int","enumValues":"","default":"","desc":"","required":true,"in":"path","ref":"","_id":"589c5b07ccb0c72500327b9e"}],"url":"/contactlists/:contact_list_id","method":"get"},"isReference":true,"order":1,"slug":"contactlists_get","type":"endpoint","title":"contactlists/:contact_list_id","parentDoc":"66b217731318ca0024ab925a","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"5a03289475d99a001c1764cf","category":"5a0cd760ddd9be00123df492","createdAt":"2017-11-08T15:53:56.169Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53b0d1065f9c438aa1adb","settings":"","results":{"codes":[{"language":"json","code":"{\n \"id\": 12345,\n \"type\": \"email\",\n \"title\": \"New Contact List\",\n \"date_created\": \"2017-11-08T15:58:31Z\",\n \"contacts\": 0,\n \"href\": \"https://api.smartsurvey.io/v1/contactlists/12345\"\n}","name":"","status":200}]},"examples":{"codes":[]},"auth":"required","params":[{"_id":"5a03299ad46da20032a46124","ref":"","in":"query","required":false,"desc":"The name of the contact list","default":"","type":"string","name":"title"}],"url":"/contactlists","method":"post"},"isReference":true,"order":2,"slug":"contactlists-insert","type":"endpoint","title":"contactlists","parentDoc":"66b217731318ca0024ab925a","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"6196638308d588037790cc03","api":{"method":"post","url":"/contactlists/customcolumns","auth":"required","apiSetting":"58b53b0d1065f9c438aa1adb","settings":"","results":{"codes":[{"language":"json","code":"{\n \"id\": 12345,\n \"type\": \"email\",\n \"title\": \"New Contact List\",\n \"date_created\": \"2017-11-08T15:58:31Z\",\n \"contacts\": 0,\n \"custom_columns\": [\n \"region\",\n \"product_code\",\n \"order_date\"\n \"href\": \"https://api.smartsurvey.io/v1/contactlists/12345\"\n}","name":"","status":200}]},"examples":{"codes":[]},"params":[{"name":"title","type":"string","enumValues":"","default":"","desc":"The name of the contact list","required":false,"in":"query","ref":"","_id":"5a03299ad46da20032a46124"},{"name":"customcolumns","type":"string","enumValues":"","default":"","desc":"the names of the custom columns, as a comma-seperated list. Example: region,product_code,order_date","required":false,"in":"query","ref":"","_id":"619664341e6c07003feafb4a"}]},"title":"contactlists/customcolumns","type":"endpoint","slug":"contactlists-1","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-11-18T14:30:27.425Z","category":"5a0cd760ddd9be00123df492","parentDoc":"66b217731318ca0024ab925a","icon":"","isBodyEmpty":true,"children":[]},{"_id":"5a032b3e74483500286fe341","category":"5a0cd760ddd9be00123df492","createdAt":"2017-11-08T16:05:18.605Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53b0d1065f9c438aa1adb","settings":"","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n \"status\": 200,\n \"code\": \"success\",\n \"message\": \"The contact list has been deleted.\"\n}"},{"status":404,"language":"json","code":"{\n \"status\": 404,\n \"code\": \"not_found\",\n \"message\": \"Tracking link with id '123' could not be found or deleted.\"\n}"}]},"examples":{"codes":[]},"auth":"required","params":[{"_id":"589c60c08912591b00fd955f","ref":"","in":"path","required":true,"desc":"","default":"","type":"long","name":"contact_list_id"}],"url":"/contactlists/:contact_list_id","method":"delete"},"isReference":true,"order":4,"slug":"contactlists-delete","type":"endpoint","title":"contactlists/:contact_list_id","parentDoc":"66b217731318ca0024ab925a","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]}]},{"_id":"66b2178df44e450043dd1f0e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Contact List Contacts","icon":"","type":"basic","slug":"contact-list-contacts","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5a0cd760ddd9be00123df492","createdAt":"2024-08-06T12:31:09.497Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5a032c76d46da20032a4618d","category":"5a0cd760ddd9be00123df492","createdAt":"2017-11-08T16:10:30.288Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"apiSetting":"58b53b0d1065f9c438aa1adb","settings":"","results":{"codes":[{"status":200,"language":"json","code":"[\n {\n \"id\": 10001,\n \"contact_list_id\": 123,\n \"type\": \"contact_email\",\n \"name\": \"Test Contact 1\",\n \"email\": \"test1@domain.co.uk\",\n \"href\": \"https://api.smartsurvey.io/v1/contactlists/123/contacts/10001\"\n },\n {\n \"id\": 10002,\n \"contact_list_id\": 123,\n \"type\": \"contact_email\",\n \"name\": \"Test Contact 2\",\n \"email\": \"test2@domain.co.uk\",\n \"href\": \"https://api.smartsurvey.io/v1/contactlists/123/contacts/10002\"\n }\n]","name":""}]},"auth":"required","params":[{"name":"contact_list_id","type":"long","enumValues":"","default":"","desc":"","required":false,"in":"path","ref":"","_id":"5da449209118c8004a9b8908"},{"name":"page_size","type":"int","enumValues":"","default":"","desc":"Number of rows to return per page","required":false,"in":"query","ref":"","_id":"649c11e5d048da0029208335"},{"name":"page","type":"int","enumValues":"","default":"","desc":"Which page to return.","required":false,"in":"query","ref":"","_id":"649c11e5d048da0029208334"}],"url":"/contactlists/:contact_list_id/contacts","method":"get"},"isReference":true,"order":0,"slug":"contactlistscontact_list_idcontacts","type":"endpoint","title":"contactlists/:contact_list_id/contacts","parentDoc":"66b2178df44e450043dd1f0e","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"5a032d3074483500286fe420","category":"5a0cd760ddd9be00123df492","createdAt":"2017-11-08T16:13:36.325Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n {\n \"id\": 10001,\n \"contact_list_id\": 123,\n \"type\": \"contact_email\",\n \"name\": \"Test Contact 1\",\n \"email\": \"test1@domain.co.uk\",\n \"columns\": {\n \"MemberID\": \"123\",\n \"LastName\": \"Smith\",\n \"MemberType\": \"Student\",\n \"JoinedDate\": \"10/04/2017 16:31\",\n \"LastVisited\": \"10/04/2017 16:31\"\n },\n \"href\": \"https://api.smartsurvey.io/v1/contactlists/123/contacts/10001\"\n }\n]","name":""}]},"settings":"","apiSetting":"58b53b0d1065f9c438aa1adb","examples":{"codes":[]},"auth":"required","params":[{"name":"contact_list_id","type":"long","enumValues":"","default":"","desc":"","required":false,"in":"path","ref":"","_id":"5f48d257741d8700120fe0a9"},{"name":"page_size","type":"int","enumValues":"","default":"","desc":"number of rows to return per page","required":false,"in":"query","ref":"","_id":"649c1257bb269f000a51e6dd"},{"name":"page","type":"int","enumValues":"","default":"","desc":"Which page to return.","required":false,"in":"query","ref":"","_id":"649c1257bb269f000a51e6dc"}],"url":"/contactlists/:contact_list_id/contacts/detailed","method":"get"},"isReference":true,"order":1,"slug":"contactlistscontact_list_idcontactsdetailed","type":"endpoint","title":"contactlists/:contact_list_id/contacts/detailed","parentDoc":"66b2178df44e450043dd1f0e","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":true,"children":[]},{"_id":"5a032dca4bd2620010a4d5cd","category":"5a0cd760ddd9be00123df492","createdAt":"2017-11-08T16:16:10.532Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 10001,\n \"contact_list_id\": 123,\n \"type\": \"contact_email\",\n \"name\": \"Test Contact 1\",\n \"email\": \"test1@domain.co.uk\",\n \"href\": \"https://api.smartsurvey.io/v1/contactlists/123/contacts/10001\"\n}","name":""}]},"settings":"","apiSetting":"58b53b0d1065f9c438aa1adb","examples":{"codes":[]},"auth":"required","params":[{"name":"contact_list_id","type":"long","default":"","desc":"","required":false,"in":"path","ref":"","_id":"5f48d288e23d89005a7ddd9f"},{"name":"contact_id","type":"long","default":"","desc":"","required":false,"in":"path","ref":"","_id":"5f48d288e23d89005a7ddd9e"}],"url":"/contactlists/:contact_list_id/contacts/:contact_id","method":"get"},"isReference":true,"order":2,"slug":"contactlist_contacts_single","type":"endpoint","title":"contactlists/:contact_list_id/contacts/:contact_id","parentDoc":"66b2178df44e450043dd1f0e","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"5a032de6d46da20032a461b3","category":"5a0cd760ddd9be00123df492","createdAt":"2017-11-08T16:16:38.100Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"apiSetting":"58b53b0d1065f9c438aa1adb","settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 10001,\n \"contact_list_id\": 123,\n \"type\": \"contact_email\",\n \"name\": \"Test Contact 1\",\n \"email\": \"test1@domain.co.uk\",\n \"columns\": {\n \"MemberID\": \"123\",\n \"LastName\": \"Smith\",\n \"MemberType\": \"Student\",\n \"JoinedDate\": \"10/04/2017 16:31\",\n \"LastVisited\": \"10/04/2017 16:31\"\n },\n \"href\": \"https://api.smartsurvey.io/v1/contactlists/123/contacts/10001\"\n}","name":""}]},"auth":"required","params":[{"name":"contact_list_id","type":"long","default":"","desc":"","required":false,"in":"path","ref":"","_id":"5f48d2965092650035710c06"},{"name":"contact_id","type":"long","default":"","desc":"","required":false,"in":"path","ref":"","_id":"5f48d2965092650035710c05"}],"url":"/contactlists/:contact_list_id/contacts/:contact_id/detailed","method":"get"},"isReference":true,"order":3,"slug":"contactlist_contacts_single_detailed","type":"endpoint","title":"contactlists/:contact_list_id/contacts/:contact_id/detailed","parentDoc":"66b2178df44e450043dd1f0e","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"5a032eb24d876d0028c21a6f","category":"5a0cd760ddd9be00123df492","createdAt":"2017-11-08T16:20:02.013Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"{\n \"email\": \"test1@domain.com\",\n \"name\": \"Test Contact 1\",\n \"custom_columns\": [\n {\n \"name\": \"LastName\",\n \"value\": \"Smith\"\n },\n {\n \"name\": \"Age\",\n \"value\": \"29\"\n }\n ]\n}","name":"Example Email Post Body"},{"code":"{\n \"mobile\": \"07595301333\",\n \"name\": \"Test Contact 1\",\n \"custom_columns\": [\n {\n \"name\": \"LastName\",\n \"value\": \"Smith\"\n },\n {\n \"name\": \"Age\",\n \"value\": \"29\"\n }\n ]\n}","language":"json","name":"Example SMS Post Body"}]},"results":{"codes":[{"language":"json","code":"{\n \"id\": 10001,\n \"contact_list_id\": 123,\n \"type\": \"contact_email\",\n \"name\": \"Test Contact 1\",\n \"email\": \"test1@domain.com\",\n \"columns\": {\n \"LastName\": \"Smith\",\n \"Age\": \"29\"\n },\n \"href\": \"https://api.smartsurvey.io/v1/contactlists/123/contacts/10001\"\n}","name":"","status":200}]},"settings":"","apiSetting":"58b53b0d1065f9c438aa1adb","auth":"required","params":[{"name":"contact_list_id","type":"long","enumValues":"","default":"","desc":"","required":false,"in":"path","ref":"","_id":"5f48d2a59edabf00182a2d15"},{"name":"RAW_BODY","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"62c82108543ad00045fdfe9d"}],"url":"/contactlists/:contact_list_id/contacts","method":"post"},"isReference":true,"order":4,"slug":"contactlists_contacts_insert","type":"endpoint","title":"contactlists/:contact_list_id/contacts","parentDoc":"66b2178df44e450043dd1f0e","previousSlug":"","deprecated":false,"isBodyEmpty":true,"children":[]}]}]}]},"baseUrl":"/","apiBaseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"MmIyZGZiYTY4MzYyODcwZmE0YjMzYmJjMjhjNzA2MjU0MmFhZTI2MWU1YzE0MjY3MmUwNDBmNTExMTY4MGU2NnRhZ0ZpbHRlcnM9KHByb2plY3Q6NTczY2RmNzBkZWYyNGYwZTAwOGU1ODU3KSwodmVyc2lvbjpub25lLHZlcnNpb246NTczY2RmNzBkZWYyNGYwZTAwOGU1ODVhKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ==","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":false,"discuss":false,"reference":true,"examples":true,"docs":true,"suggested_edits":true,"changelog":false,"logs":false,"custompages":false,"tutorials":false,"graphql":false},"id":"573cdf70def24f0e008e5857","name":"SmartSurvey API","subdomain":"smartsurvey","subpath":"","nav_names":{"docs":"","discuss":"","reference":"","changelog":"","tutorials":"","recipes":""}}],"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"smartsurvey"},"version":"1"}},"activeDoc":"getting-started","rdmd":{"baseUrl":"/","body":"## API Basics\n\nThe SmartSurvey API gives you access to secure survey data for use in your own app. It strives to be RESTful and is organised around the main resources you’re familiar with from the SmartSurvey web interface.\n\nBefore you do anything, you should make sure you have a SmartSurvey account that you can test the API against and register for an API key so that you can make API calls.\n\nThe SmartSurvey API is a RESTful API, which adheres to the guidelines defined by REST. You can read more information about REST on the following link:\n[https://en.wikipedia.org/wiki/Representational_state_transfer#RESTful_web_services](https://en.wikipedia.org/wiki/Representational_state_transfer#RESTful_web_services)\n\n## Getting Your API Key\n\nIn order to use SmartSurvey API, you will need to request an API key from within your account dashboard. \n\nFollow the steps below to get your API key:\n * Login to your account\n * Click on My Account\n * Click on API Keys\n * Request API Access\n * If you have not already requested one, click on request key.\n * Click Add New API Key\n * Once the key appears, use this to authenticate with the API\n\nIf you do not see this option within your account, please <a href=\"https://www.smartsurvey.co.uk/contact\">contact us</a> for further assistance.\n\n## Authentication\nYour API requests must use [Basic Auth](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme) for authentication. All API tooling should support this mechanism which should encode your api token and secret into a specific format, which is then passed in an HTTP header like this:\n\n`Authorization: Basic <token>`\n\nYou should not need to create this header manually, which is slightly complicated and which can cause various errors if not done correctly.\n\nFailed authentication will return an HTTP 401 Unauthorized response.\n\nPreviously, we supported querystring parameters but these are now *deprecated* and all requests should switch to using Basic auth.\n\nE.g. `https://api.smartsurvey.io/v1/surveys?api_token=XXXXX&api_token_secret=XXXXX`\n\nNote that if you are migrating to using Basic Auth, as soon as you provide an Authorization http header, the querystring parameters will be ignored even if they are correct. For this reason, a malformed Authorization header will cause a 401 even if you are still passing the querystring parameters.\n\n\n[block:callout]\n{\n \"type\": \"warning\",\n \"title\": \"Basic Auth, Usernames and Passwords\",\n \"body\": \"Some Basic Auth examples and documentation, and the test function on the API refrerence pages, will refer to a \\\"Username\\\" and \\\"Password\\\". In the context of SmartSurvey API requests, \\\"Username\\\" is the API Token. \\\"Password\\\" is the Token Secret.\\n\\nDo not try and use your SmartSurvey login credentials. This will not work, and will generate a 401 error.\"\n}\n[/block]\n## Example API Request\n\n`GET https://api.smartsurvey.io/v1/surveys`\n\nIn this example, the returned content will be inferred from the authenticated account i.e. you will get a list of all surveys linked to the authenticated account.\n\n`GET https://api.smartsurvey.io/v1/surveys/12345`\n\nIn this example, when requesting a specific object (e.g. survey 12345), then if you are not permitted to access it with the authenticated account, you will receive am HTTP 403 Forbidden response.\n\nIf using POST or PUT, you must use either application/json, text/xml or application/xml as the content-type for the request, with the body formatted accordingly otherwise you will receive a 415 error response.\n\n\n## Output Formats\n\nThe SmartSurvey API provides the output/response for an API request in the following\nformats.\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Format\",\n \"0-0\": \"<code>JSON</code>\\n*default*\",\n \"1-0\": \"<code>XML</code>\",\n \"h-1\": \"Accept Header\",\n \"0-1\": \"application/json\",\n \"1-1\": \"application/xml\"\n },\n \"cols\": 2,\n \"rows\": 2\n}\n[/block]\nYou can change the output format by providing an \"Accept\" request header with the above values.\n \n## Pagination\n\nSome endpoints that return arrays support <code>page</code> and <code>page_size</code> as URL parameters. <code>page</code> defines the page index and <code>page_size</code> defines the number of records that will be returned on a page. The number of records is not guaranteed to be the number specified as visibility rules may filter out items. \n\n<b>Query Parameters:</b>\n* <code>page</code> – page of records to return (defaults to 1)\n* <code>page_size</code> – number of records to return per page (defaults to 10, max is 100)\nIf successful, you should receive the following custom headers in your response:\n\nFor example:\nhttps://<span></span>api.smartsurvey.io/v/1/surveys/{surveyId}/responses/?**page=1**&**page_size=100**\n[block:parameters]\n{\n \"data\": {\n \"0-0\": \"<code>X-SS-Pagination-Page</code>\",\n \"0-1\": \"The page number requested.\",\n \"1-0\": \"<code>X-SS-Pagination-PageSize</code>\",\n \"2-0\": \"<code>X-SS-Pagination-Total</code>\",\n \"3-0\": \"<code>X-SS-Pagination-Returned</code>\",\n \"1-1\": \"Number of rows requested.\",\n \"2-1\": \"The total number of rows found in database.\",\n \"3-1\": \"The total number of rows returned.\"\n },\n \"cols\": 2,\n \"rows\": 4\n}\n[/block]\n## Date Formats\n\nNOTE: . \n\nDate-time information is always returned in UTC and ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). You will need to adjust the timezone to suit your needs.\n\nDates sent to the API must be Unix epoch timestamp and should be formatted as shown in the example below: \n\nExample: Fri, 01 Jan 2016 00:00:00 UTC = 1451606400 (UTC Timestamp)\n\n\n## Versioning\n\nThis REST API version v1 is our first API version. The API version is likely to change from v1 to vN {N = 1 …. n} if any structural changes are made to the existing version.\n\n## Security\n\nAll function calls included in SmartSurvey API are provided over https (Transport Layer Security). This ensures that your data is transmitted through a secure channel between our server and your client.\n\n## Include Labels\n\nWhen making requests to get survey responses, by default, the labels are not included. To include them, you just need to append \"&include_labels=true\" with your request.\n\nFor example:\nhttps://<span></span>api.smartsurvey.io/v/1/surveys/{surveyId}/responses/?**include_labels=true**","opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"normalize":true,"lazyImages":true,"reusableContent":{"tags":{},"wrap":false},"safeMode":false,"settings":{"position":true},"theme":"light","resourceID":"573cdf70def24f0e008e585d","resourceType":"page","baseUrl":"/","terms":[],"variables":{"user":{},"defaults":[{"source":"security","_id":"66b0f9c2bcbb29001805fa07","name":"Basic","type":"http","scheme":"basic","apiSetting":"66b0f9c2bcbb29001805fa04"}]}},"terms":[],"variables":{"user":{},"defaults":[{"source":"security","_id":"66b0f9c2bcbb29001805fa07","name":"Basic","type":"http","scheme":"basic","apiSetting":"66b0f9c2bcbb29001805fa04"}]},"mdx":false,"dehydrated":{"toc":"<nav><ul class=\"toc-list\"><li><a class=\"tocHeader\" href=\"#\"><i class=\"icon icon-text-align-left\"></i>Table of Contents</a></li><li class=\"toc-children\"><ul>\n<li><a href=\"#api-basics\">API Basics</a></li>\n<li><a href=\"#getting-your-api-key\">Getting Your API Key</a></li>\n<li><a href=\"#authentication\">Authentication</a></li>\n<li><a href=\"#example-api-request\">Example API Request</a></li>\n<li><a href=\"#output-formats\">Output Formats</a></li>\n<li><a href=\"#pagination\">Pagination</a></li>\n<li><a href=\"#date-formats\">Date Formats</a></li>\n<li><a href=\"#versioning\">Versioning</a></li>\n<li><a href=\"#security\">Security</a></li>\n<li><a href=\"#include-labels\">Include Labels</a></li>\n</ul></li></ul></nav>","body":"<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"api-basics\"></div><div class=\"heading-text\"><div id=\"section-api-basics\" class=\"heading-anchor_backwardsCompatibility\"></div>API Basics</div><a aria-label=\"Skip link to API Basics\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#api-basics\"></a></h2>\n<p>The SmartSurvey API gives you access to secure survey data for use in your own app. It strives to be RESTful and is organised around the main resources you’re familiar with from the SmartSurvey web interface.</p>\n<p>Before you do anything, you should make sure you have a SmartSurvey account that you can test the API against and register for an API key so that you can make API calls.</p>\n<p>The SmartSurvey API is a RESTful API, which adheres to the guidelines defined by REST. You can read more information about REST on the following link:<br/>\n<a href=\"https://en.wikipedia.org/wiki/Representational_state_transfer#RESTful_web_services\" target=\"\" title=\"\">https://en.wikipedia.org/wiki/Representational_state_transfer#RESTful_web_services</a></p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"getting-your-api-key\"></div><div class=\"heading-text\"><div id=\"section-getting-your-api-key\" class=\"heading-anchor_backwardsCompatibility\"></div>Getting Your API Key</div><a aria-label=\"Skip link to Getting Your API Key\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#getting-your-api-key\"></a></h2>\n<p>In order to use SmartSurvey API, you will need to request an API key from within your account dashboard. </p>\n<p>Follow the steps below to get your API key:</p>\n<ul>\n<li>Login to your account</li>\n<li>Click on My Account</li>\n<li>Click on API Keys</li>\n<li>Request API Access</li>\n<li>If you have not already requested one, click on request key.</li>\n<li>Click Add New API Key</li>\n<li>Once the key appears, use this to authenticate with the API</li>\n</ul>\n<p>If you do not see this option within your account, please <a href=\"https://www.smartsurvey.co.uk/contact\" target=\"\" title=\"\">contact us</a> for further assistance.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"authentication\"></div><div class=\"heading-text\"><div id=\"section-authentication\" class=\"heading-anchor_backwardsCompatibility\"></div>Authentication</div><a aria-label=\"Skip link to Authentication\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#authentication\"></a></h2>\n<p>Your API requests must use <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme\" target=\"\" title=\"\">Basic Auth</a> for authentication. All API tooling should support this mechanism which should encode your api token and secret into a specific format, which is then passed in an HTTP header like this:</p>\n<p><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">Authorization: Basic &lt;token&gt;</code></p>\n<p>You should not need to create this header manually, which is slightly complicated and which can cause various errors if not done correctly.</p>\n<p>Failed authentication will return an HTTP 401 Unauthorized response.</p>\n<p>Previously, we supported querystring parameters but these are now <em>deprecated</em> and all requests should switch to using Basic auth.</p>\n<p>E.g. <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">https://api.smartsurvey.io/v1/surveys?api_token=XXXXX&amp;api_token_secret=XXXXX</code></p>\n<p>Note that if you are migrating to using Basic Auth, as soon as you provide an Authorization http header, the querystring parameters will be ignored even if they are correct. For this reason, a malformed Authorization header will cause a 401 even if you are still passing the querystring parameters.</p>\n<blockquote class=\"callout callout_warn\" theme=\"🚧\"><h2 class=\"callout-heading\"><span class=\"callout-icon\">🚧</span><p>Basic Auth, Usernames and Passwords</p></h2><p>Some Basic Auth examples and documentation, and the test function on the API refrerence pages, will refer to a &quot;Username&quot; and &quot;Password&quot;. In the context of SmartSurvey API requests, &quot;Username&quot; is the API Token. &quot;Password&quot; is the Token Secret.</p><p>Do not try and use your SmartSurvey login credentials. This will not work, and will generate a 401 error.</p></blockquote>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"example-api-request\"></div><div class=\"heading-text\"><div id=\"section-example-api-request\" class=\"heading-anchor_backwardsCompatibility\"></div>Example API Request</div><a aria-label=\"Skip link to Example API Request\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#example-api-request\"></a></h2>\n<p><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">GET https://api.smartsurvey.io/v1/surveys</code></p>\n<p>In this example, the returned content will be inferred from the authenticated account i.e. you will get a list of all surveys linked to the authenticated account.</p>\n<p><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">GET https://api.smartsurvey.io/v1/surveys/12345</code></p>\n<p>In this example, when requesting a specific object (e.g. survey 12345), then if you are not permitted to access it with the authenticated account, you will receive am HTTP 403 Forbidden response.</p>\n<p>If using POST or PUT, you must use either application/json, text/xml or application/xml as the content-type for the request, with the body formatted accordingly otherwise you will receive a 415 error response.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"output-formats\"></div><div class=\"heading-text\"><div id=\"section-output-formats\" class=\"heading-anchor_backwardsCompatibility\"></div>Output Formats</div><a aria-label=\"Skip link to Output Formats\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#output-formats\"></a></h2>\n<p>The SmartSurvey API provides the output/response for an API request in the following<br/>\nformats.</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<div class=\"rdmd-table\"><div class=\"rdmd-table-inner\"><table><thead><tr><th style=\"text-align:left\">Format</th><th style=\"text-align:left\">Accept Header</th></tr></thead><tbody><tr><td style=\"text-align:left\"><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">JSON</code><br/><em>default</em></td><td style=\"text-align:left\">application/json</td></tr><tr><td style=\"text-align:left\"><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">XML</code></td><td style=\"text-align:left\">application/xml</td></tr></tbody></table></div></div>\n<p>You can change the output format by providing an &quot;Accept&quot; request header with the above values.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"pagination\"></div><div class=\"heading-text\"><div id=\"section-pagination\" class=\"heading-anchor_backwardsCompatibility\"></div>Pagination</div><a aria-label=\"Skip link to Pagination\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#pagination\"></a></h2>\n<p>Some endpoints that return arrays support <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">page</code> and <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">page_size</code> as URL parameters. <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">page</code> defines the page index and <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">page_size</code> defines the number of records that will be returned on a page. The number of records is not guaranteed to be the number specified as visibility rules may filter out items. </p>\n<p><b>Query Parameters:</b></p>\n<ul>\n<li><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">page</code> – page of records to return (defaults to 1)</li>\n<li><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">page_size</code> – number of records to return per page (defaults to 10, max is 100)<br/>\nIf successful, you should receive the following custom headers in your response:</li>\n</ul>\n<p>For example:<br/>\nhttps://<span></span>api.smartsurvey.io/v/1/surveys/{surveyId}/responses/?<strong>page=1</strong>&amp;<strong>page_size=100</strong></p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<div class=\"rdmd-table\"><div class=\"rdmd-table-inner\"><table><thead><tr><th style=\"text-align:left\"></th><th style=\"text-align:left\"></th></tr></thead><tbody><tr><td style=\"text-align:left\"><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">X-SS-Pagination-Page</code></td><td style=\"text-align:left\">The page number requested.</td></tr><tr><td style=\"text-align:left\"><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">X-SS-Pagination-PageSize</code></td><td style=\"text-align:left\">Number of rows requested.</td></tr><tr><td style=\"text-align:left\"><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">X-SS-Pagination-Total</code></td><td style=\"text-align:left\">The total number of rows found in database.</td></tr><tr><td style=\"text-align:left\"><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">X-SS-Pagination-Returned</code></td><td style=\"text-align:left\">The total number of rows returned.</td></tr></tbody></table></div></div>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"date-formats\"></div><div class=\"heading-text\"><div id=\"section-date-formats\" class=\"heading-anchor_backwardsCompatibility\"></div>Date Formats</div><a aria-label=\"Skip link to Date Formats\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#date-formats\"></a></h2>\n<p>NOTE: . </p>\n<p>Date-time information is always returned in UTC and ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). You will need to adjust the timezone to suit your needs.</p>\n<p>Dates sent to the API must be Unix epoch timestamp and should be formatted as shown in the example below: </p>\n<p>Example: Fri, 01 Jan 2016 00:00:00 UTC = 1451606400 (UTC Timestamp)</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"versioning\"></div><div class=\"heading-text\"><div id=\"section-versioning\" class=\"heading-anchor_backwardsCompatibility\"></div>Versioning</div><a aria-label=\"Skip link to Versioning\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#versioning\"></a></h2>\n<p>This REST API version v1 is our first API version. The API version is likely to change from v1 to vN {N = 1 …. n} if any structural changes are made to the existing version.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"security\"></div><div class=\"heading-text\"><div id=\"section-security\" class=\"heading-anchor_backwardsCompatibility\"></div>Security</div><a aria-label=\"Skip link to Security\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#security\"></a></h2>\n<p>All function calls included in SmartSurvey API are provided over https (Transport Layer Security). This ensures that your data is transmitted through a secure channel between our server and your client.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"include-labels\"></div><div class=\"heading-text\"><div id=\"section-include-labels\" class=\"heading-anchor_backwardsCompatibility\"></div>Include Labels</div><a aria-label=\"Skip link to Include Labels\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#include-labels\"></a></h2>\n<p>When making requests to get survey responses, by default, the labels are not included. To include them, you just need to append &quot;&amp;include_labels=true&quot; with your request.</p>\n<p>For example:<br/>\nhttps://<span></span>api.smartsurvey.io/v/1/surveys/{surveyId}/responses/?<strong>include_labels=true</strong></p>"}},"doc":{"metadata":{"image":[],"title":"","description":"","keywords":"","robots":"index"},"mdx":{"altBody":"","status":"rdmd"},"api":{"method":"get","url":"","auth":"required","apiSetting":null,"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"next":{"description":"","pages":[]},"algolia":{"recordCount":10,"publishPending":false,"translationFailure":false,"updatedAt":"2024-08-07T10:28:00.444Z"},"title":"Getting Started","icon":"","updates":["5d1f0cff0898130039dd7430","5ed033850290100063d730a1"],"type":"basic","slug":"getting-started","excerpt":"Welcome to the documentation for the SmartSurvey API. Here we will explain to you how to authenticate your API calls, what error codes we use, how we do versioning, and how you can use the API.","body":"## API Basics\n\nThe SmartSurvey API gives you access to secure survey data for use in your own app. It strives to be RESTful and is organised around the main resources you’re familiar with from the SmartSurvey web interface.\n\nBefore you do anything, you should make sure you have a SmartSurvey account that you can test the API against and register for an API key so that you can make API calls.\n\nThe SmartSurvey API is a RESTful API, which adheres to the guidelines defined by REST. You can read more information about REST on the following link:\n[https://en.wikipedia.org/wiki/Representational_state_transfer#RESTful_web_services](https://en.wikipedia.org/wiki/Representational_state_transfer#RESTful_web_services)\n\n## Getting Your API Key\n\nIn order to use SmartSurvey API, you will need to request an API key from within your account dashboard. \n\nFollow the steps below to get your API key:\n * Login to your account\n * Click on My Account\n * Click on API Keys\n * Request API Access\n * If you have not already requested one, click on request key.\n * Click Add New API Key\n * Once the key appears, use this to authenticate with the API\n\nIf you do not see this option within your account, please <a href=\"https://www.smartsurvey.co.uk/contact\">contact us</a> for further assistance.\n\n## Authentication\nYour API requests must use [Basic Auth](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme) for authentication. All API tooling should support this mechanism which should encode your api token and secret into a specific format, which is then passed in an HTTP header like this:\n\n`Authorization: Basic <token>`\n\nYou should not need to create this header manually, which is slightly complicated and which can cause various errors if not done correctly.\n\nFailed authentication will return an HTTP 401 Unauthorized response.\n\nPreviously, we supported querystring parameters but these are now *deprecated* and all requests should switch to using Basic auth.\n\nE.g. `https://api.smartsurvey.io/v1/surveys?api_token=XXXXX&api_token_secret=XXXXX`\n\nNote that if you are migrating to using Basic Auth, as soon as you provide an Authorization http header, the querystring parameters will be ignored even if they are correct. For this reason, a malformed Authorization header will cause a 401 even if you are still passing the querystring parameters.\n\n\n[block:callout]\n{\n \"type\": \"warning\",\n \"title\": \"Basic Auth, Usernames and Passwords\",\n \"body\": \"Some Basic Auth examples and documentation, and the test function on the API refrerence pages, will refer to a \\\"Username\\\" and \\\"Password\\\". In the context of SmartSurvey API requests, \\\"Username\\\" is the API Token. \\\"Password\\\" is the Token Secret.\\n\\nDo not try and use your SmartSurvey login credentials. This will not work, and will generate a 401 error.\"\n}\n[/block]\n## Example API Request\n\n`GET https://api.smartsurvey.io/v1/surveys`\n\nIn this example, the returned content will be inferred from the authenticated account i.e. you will get a list of all surveys linked to the authenticated account.\n\n`GET https://api.smartsurvey.io/v1/surveys/12345`\n\nIn this example, when requesting a specific object (e.g. survey 12345), then if you are not permitted to access it with the authenticated account, you will receive am HTTP 403 Forbidden response.\n\nIf using POST or PUT, you must use either application/json, text/xml or application/xml as the content-type for the request, with the body formatted accordingly otherwise you will receive a 415 error response.\n\n\n## Output Formats\n\nThe SmartSurvey API provides the output/response for an API request in the following\nformats.\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Format\",\n \"0-0\": \"<code>JSON</code>\\n*default*\",\n \"1-0\": \"<code>XML</code>\",\n \"h-1\": \"Accept Header\",\n \"0-1\": \"application/json\",\n \"1-1\": \"application/xml\"\n },\n \"cols\": 2,\n \"rows\": 2\n}\n[/block]\nYou can change the output format by providing an \"Accept\" request header with the above values.\n \n## Pagination\n\nSome endpoints that return arrays support <code>page</code> and <code>page_size</code> as URL parameters. <code>page</code> defines the page index and <code>page_size</code> defines the number of records that will be returned on a page. The number of records is not guaranteed to be the number specified as visibility rules may filter out items. \n\n<b>Query Parameters:</b>\n* <code>page</code> – page of records to return (defaults to 1)\n* <code>page_size</code> – number of records to return per page (defaults to 10, max is 100)\nIf successful, you should receive the following custom headers in your response:\n\nFor example:\nhttps://<span></span>api.smartsurvey.io/v/1/surveys/{surveyId}/responses/?**page=1**&**page_size=100**\n[block:parameters]\n{\n \"data\": {\n \"0-0\": \"<code>X-SS-Pagination-Page</code>\",\n \"0-1\": \"The page number requested.\",\n \"1-0\": \"<code>X-SS-Pagination-PageSize</code>\",\n \"2-0\": \"<code>X-SS-Pagination-Total</code>\",\n \"3-0\": \"<code>X-SS-Pagination-Returned</code>\",\n \"1-1\": \"Number of rows requested.\",\n \"2-1\": \"The total number of rows found in database.\",\n \"3-1\": \"The total number of rows returned.\"\n },\n \"cols\": 2,\n \"rows\": 4\n}\n[/block]\n## Date Formats\n\nNOTE: . \n\nDate-time information is always returned in UTC and ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). You will need to adjust the timezone to suit your needs.\n\nDates sent to the API must be Unix epoch timestamp and should be formatted as shown in the example below: \n\nExample: Fri, 01 Jan 2016 00:00:00 UTC = 1451606400 (UTC Timestamp)\n\n\n## Versioning\n\nThis REST API version v1 is our first API version. The API version is likely to change from v1 to vN {N = 1 …. n} if any structural changes are made to the existing version.\n\n## Security\n\nAll function calls included in SmartSurvey API are provided over https (Transport Layer Security). This ensures that your data is transmitted through a secure channel between our server and your client.\n\n## Include Labels\n\nWhen making requests to get survey responses, by default, the labels are not included. To include them, you just need to append \"&include_labels=true\" with your request.\n\nFor example:\nhttps://<span></span>api.smartsurvey.io/v/1/surveys/{surveyId}/responses/?**include_labels=true**","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"reusableContent":[],"previousSlug":"","slugUpdatedAt":"2021-08-11T01:17:34.292Z","revision":4,"_id":"573cdf70def24f0e008e585d","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["573cdf70def24f0e008e585b","573ce6c947337f0e00b6d87c","573d7f43e1ec4a2000e814a5","574b95216a29ec2200b74817","574c88905953e20e00f40f36","589c59b30552cc2f00a61cf7","58ece0c3dbdd4e2500ae1b6f","58ece2d765565b2d0044c802","5a0327754bd2620010a4d4e2","5a032bc84d876d0028c21a57","5a0cd760ddd9be00123df492","5a70a49d54f17a003acfa07d","5cb099c47fa53e00395b22d0","6376beff127d99000316be7c"],"pdfStatus":"","_id":"573cdf70def24f0e008e585a","createdAt":"2016-05-18T21:32:32.372Z","releaseDate":"2016-05-18T21:32:32.372Z","__v":13,"project":"573cdf70def24f0e008e5857"},"githubsync":"","__v":27,"category":{"title":"API","slug":"documentation","order":1,"reference":false,"_id":"573cdf70def24f0e008e585b","createdAt":"2016-05-18T21:32:32.394Z","version":"573cdf70def24f0e008e585a","__v":0,"project":"573cdf70def24f0e008e5857","from_sync":false,"type":"guide","id":"573cdf70def24f0e008e585b"},"createdAt":"2016-05-18T21:32:32.424Z","parentDoc":null,"project":"573cdf70def24f0e008e5857","user":"605b0ac8127063004874ea6b","updatedAt":"2022-09-22T14:00:02.306Z","pendingAlgoliaPublish":false,"isApi":false,"tutorials":[],"id":"573cdf70def24f0e008e585d"},"hideTOC":false,"meta":{"_id":"573cdf70def24f0e008e585d","description":"Welcome to the documentation for the SmartSurvey API. Here we will explain to you how to authenticate your API calls, what error codes we use, how we do versioning, and how you can use the API.","hidden":false,"image":[],"keywords":"","metaTitle":"Getting Started","parent":null,"robots":"index","slug":"getting-started","title":"Getting Started","type":"docs"},"slugUrl":"/docs/getting-started","config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.239.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[],"variables":{"user":{},"defaults":[{"source":"security","_id":"66b0f9c2bcbb29001805fa07","name":"Basic","type":"http","scheme":"basic","apiSetting":"66b0f9c2bcbb29001805fa04"}]},"project":{"_id":"573cdf70def24f0e008e5857","appearance":{"javascript_hub2":"","overlay":"triangles","colors":{"highlight":"","main":"#ff6b00","main_alt":"","body_highlight":"","header_text":"","custom_login_link_color":""},"hide_logo":false,"stylesheet_hub2":"","link_logo_to_url":true,"logo_white":["https://files.readme.io/2d62df5-small-smartsurvey-logo-whiteout-large.png","smartsurvey-logo-whiteout-large.png",308,55,"#ffffff","https://files.readme.io/50be09b-smartsurvey-logo-whiteout-large.png"],"theme":"line","typography":{"typekit":false,"body":"Open+Sans:400:sans-serif","headline":"Open+Sans:400:sans-serif","tk_body":"","tk_headline":"","tk_key":""},"html_footer":"","html_footer_meta":"","html_promo":"","landing":false,"html_hidelinks":false,"javascript":"","logo":["https://files.readme.io/c59d98f-small-smartsurvey-logo-on-white-large.png","smartsurvey-logo-on-white-large.png",434,80,"#a6684a","https://files.readme.io/3506a42-smartsurvey-logo-on-white-large.png"],"body":{"style":"threes"},"header":{"style":"solid","img_pos":"tl","img_size":"auto","img":[]},"sticky":true,"html_body":"<ul class=\"category-list\">\n <li class=\"starCat\">\n <a href=\"https://smartsurvey.zendesk.com/hc/en-us/categories/200802759-Getting-Started\">\n \t<img src=\"https://s3-eu-west-1.amazonaws.com/aws.smartsurvey.co.uk/_files/cabinet/49836_Ok-48.png\" alt=\"Getting Started\">\n <h5>Getting Started</h5>\n \t<p>Giving you the basics to get you started creating surveys.</p>\n </a>\n </li>\n <li class=\"starCat\">\n <a href=\"https://smartsurvey.zendesk.com/hc/en-us/categories/200803209-Most-Popular\">\n <img src=\"https://s3-eu-west-1.amazonaws.com/aws.smartsurvey.co.uk/_files/cabinet/49835_Heart-48.png\" alt=\"Most Popular\">\n <h5>Most Popular</h5>\n <p>The most searched for guides regarding SmartSurvey.</p>\n \t</a>\n </li>\n <li class=\"starCat\">\n <a href=\"https://smartsurvey.zendesk.com/hc/en-us/categories/200827145-Tips\">\n <img src=\"https://s3-eu-west-1.amazonaws.com/aws.smartsurvey.co.uk/_files/cabinet/49834_Bulb-48.png\" alt=\"Tips\">\n <h5>Tips</h5>\n <p>Find a collection of different tips that you can implement.</p>\n \t</a>\n </li>\n <li>\n <a href=\"https://smartsurvey.zendesk.com/hc/en-us/categories/200802789-Create\">\n <img src=\"https://s3-eu-west-1.amazonaws.com/aws.smartsurvey.co.uk/_files/cabinet/49832_AddFile-50.png\" alt=\"Create\">\n <h5>Create</h5>\n <p>Create new surveys ready to send out to your users.</p>\n \t</a>\n </li>\n <li>\n <a href=\"https://smartsurvey.zendesk.com/hc/en-us/categories/200802899-Send-Collect\">\n <img src=\"https://s3-eu-west-1.amazonaws.com/aws.smartsurvey.co.uk/_files/cabinet/49833_PaperPlane-50.png\" alt=\"Send &amp; Collect\">\n <h5>Send &amp; Collect</h5>\n <p>How to send out your surveys to start getting results.</p>\n \t</a>\n </li>\n <li>\n <a href=\"https://smartsurvey.zendesk.com/hc/en-us/categories/200826765-Results-Analysis\">\n <img src=\"https://s3-eu-west-1.amazonaws.com/aws.smartsurvey.co.uk/_files/cabinet/49831_ComboChart-50.png\" alt=\"Results &amp; Analysis\">\n <h5>Results &amp; Analysis</h5>\n <p>Start collecting results ready for analysis with our help.</p>\n \t</a>\n </li>\n <li>\n <a href=\"https://smartsurvey.zendesk.com/hc/en-us/categories/200802889-Themes\">\n <img src=\"https://s3-eu-west-1.amazonaws.com/aws.smartsurvey.co.uk/_files/cabinet/49830_PaintBrush-50.png\" alt=\"Themes\">\n <h5>Themes</h5>\n <p>Customise the appearance of your survey to stand out.</p>\n \t</a>\n </li>\n <li>\n <a href=\"https://smartsurvey.zendesk.com/hc/en-us/categories/200827115-User-Management\">\n <img src=\"https://s3-eu-west-1.amazonaws.com/aws.smartsurvey.co.uk/_files/cabinet/49829_UserGroup-50.png\" alt=\"User Management\">\n <h5>User Management</h5>\n <p>Find out how you can manage your users effectively on SmartSurvey.</p>\n </a>\n </li>\n <li>\n \t<a href=\"https://smartsurvey.zendesk.com/hc/en-us/categories/200803199-Account-Billing\">\n <img src=\"https://s3-eu-west-1.amazonaws.com/aws.smartsurvey.co.uk/_files/cabinet/49828_EditProperty-50.png\" alt=\"Account &amp; Billing\">\n <h5>Account &amp; Billing</h5>\n <p>Helping you keep your account and billing up to date.</p>\n </a>\n </li>\n </ul>","logo_white_use":false,"stylesheet":".cm-number {color:orange}\n\ncode {\n padding: 2px 4px;\n font-size: 90%;\n color: #C78725;\n background-color: #F9F7F2;\n border-radius: 4px;\n}","favicon":["https://files.readme.io/7da1d2d-favicon.ico","favicon.ico",32,32,"#000000"],"html_head":"","main_body":{"type":"all-docs"},"notheme":false,"promos":[{"extras":{"type":"buttons","buttonPrimary":"get-started","buttonSecondary":""},"title":"The SmartSurvey API","text":"Welcome to the SmartSurvey API documentation. You'll find comprehensive guides and documentation to help you start working with the SmartSurvey API as quickly as possible, as well as support if you get stuck. Let's jump right in!","_id":"573cdf70def24f0e008e5858"}],"showVersion":true,"referenceLayout":"row","childrenAsPills":false,"global_landing_page":{"html":"","redirect":""},"hideTableOfContents":false,"nextStepsLabel":"","splitReferenceDocs":false,"subheaderStyle":"dropdown","rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"showMetricsInReference":true,"referenceSimpleMode":true,"stylesheet_hub3":"","loginLogo":[],"logo_large":false,"colorScheme":"light","changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false},"custom_domain":"docs.smartsurvey.io","childrenProjects":[],"derivedPlan":"startup","description":"SmartSurvey API provides access to survey data, from listing all surveys to getting all the responses for a survey.","error404":"","experiments":[],"first_page":"landing","flags":{"migrationSwaggerRun":true,"oauth":false,"speedyRender":false,"swagger":false,"allow_hub2":false,"correctnewlines":false,"migrationRun":true,"allowXFrame":false,"hub2":true,"newApiExplorer":true,"alwaysShowDocPublishStatus":false,"cookieAuthentication":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"enterprise":false,"hideGoogleAnalytics":false,"newEditor":true,"newMarkdown":false,"translation":false,"newMarkdownBetaProgram":true,"newMarkdownLooseMode":false,"newSearch":true,"allowApiExplorerJsonEditor":false,"oldMarkdown":false,"rdmdCompatibilityMode":false,"staging":false,"tutorials":true,"useReactApp":true,"newHeader":false,"referenceRedesign":false,"auth0Oauth":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":true,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":false,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":false,"superHub":false,"developerDashboard":false,"allowReusableOTPs":false,"dashHomeRefresh":false,"owlbotAi":false,"apiV2":false,"git":{"read":false,"write":false},"superHubBeta":false,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":false},"fullBaseUrl":"https://docs.smartsurvey.io/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"connectedRepository":{"organization":{},"privacy":{}},"installationRequest":{},"github":[]}},"glossaryTerms":[],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"hasOneChild":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"links","alignment":"left"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"thumbsEnabled":false,"planLimit":1000000,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":false,"discuss":false,"reference":true,"examples":true,"docs":true,"suggested_edits":true,"changelog":false,"logs":false,"custompages":false,"tutorials":false,"graphql":false},"name":"SmartSurvey API","nav_names":{"docs":"","discuss":"","reference":"","changelog":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":true,"api":true,"logs":false,"domain":true,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"startup","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"startup","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":false,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":false,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"percentScore":25,"totalScore":158},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"573cdf70def24f0e008e585a","createdAt":"2016-05-18T21:32:32.372Z","is_deprecated":false,"is_hidden":false,"releaseDate":"2016-05-18T21:32:32.372Z","__v":13,"categories":["573cdf70def24f0e008e585b","573ce6c947337f0e00b6d87c","573d7f43e1ec4a2000e814a5","574b95216a29ec2200b74817","574c88905953e20e00f40f36","589c59b30552cc2f00a61cf7","58ece0c3dbdd4e2500ae1b6f","58ece2d765565b2d0044c802","5a0327754bd2620010a4d4e2","5a032bc84d876d0028c21a57","5a0cd760ddd9be00123df492","5a70a49d54f17a003acfa07d","5cb099c47fa53e00395b22d0","6376beff127d99000316be7c"],"codename":"","is_beta":false,"is_stable":true,"project":"573cdf70def24f0e008e5857","version":"1","version_clean":"1.0.0"},"subdomain":"smartsurvey","subpath":"","superHubWaitlist":false,"topnav":{"edited":true,"left":[{"type":"home","text":"Home"},{"type":"docs","text":"Guides"},{"type":"reference","text":"API Reference"}],"right":[],"bottom":[]},"trial":{"trialDeadlineEnabled":false,"trialEndsAt":"2019-08-16T08:00:41.574Z"},"translate":{"languages":[],"provider":"transifex","key_public":"","org_name":"","project_name":"","show_widget":false},"url":"https://www.smartsurvey.co.uk","versions":[{"_id":"573cdf70def24f0e008e585a","createdAt":"2016-05-18T21:32:32.372Z","is_deprecated":false,"is_hidden":false,"releaseDate":"2016-05-18T21:32:32.372Z","__v":13,"categories":["573cdf70def24f0e008e585b","573ce6c947337f0e00b6d87c","573d7f43e1ec4a2000e814a5","574b95216a29ec2200b74817","574c88905953e20e00f40f36","589c59b30552cc2f00a61cf7","58ece0c3dbdd4e2500ae1b6f","58ece2d765565b2d0044c802","5a0327754bd2620010a4d4e2","5a032bc84d876d0028c21a57","5a0cd760ddd9be00123df492","5a70a49d54f17a003acfa07d","5cb099c47fa53e00395b22d0","6376beff127d99000316be7c"],"codename":"","is_beta":false,"is_stable":true,"project":"573cdf70def24f0e008e5857","version":"1","version_clean":"1.0.0"},{"_id":"66b0fbdfe5f1c80019208053","version":"2","version_clean":"2.0.0","codename":"","is_stable":false,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["66b0fbdfe5f1c80019208012","66b0fbdfe5f1c80019208013","66b0fbdfe5f1c80019208014","66b0fbdfe5f1c80019208015","66b0fbdfe5f1c80019208016","66b0fbdfe5f1c80019208017","58ece0c3dbdd4e2500ae1b6f","66b0fbdfe5f1c80019208018","66b0fbdfe5f1c80019208019","66b0fbdfe5f1c8001920801a","66b0fbdfe5f1c8001920801b","66b0fbdfe5f1c8001920801c","66b0fbdfe5f1c8001920801d","66b0fbdfe5f1c8001920801e","66b32eabf128f4000fb0ae99"],"createdAt":"2024-08-05T16:20:47.230Z","releaseDate":"2016-05-18T21:32:32.372Z","__v":0,"project":"573cdf70def24f0e008e5857","forked_from":"573cdf70def24f0e008e585a","updatedAt":"2024-10-29T16:06:25.120Z","pdfStatus":""}],"variableDefaults":[{"source":"security","_id":"66b0f9c2bcbb29001805fa07","name":"Basic","type":"http","scheme":"basic","apiSetting":"66b0f9c2bcbb29001805fa04"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","glossary":[],"canonical_url":null,"description":"SmartSurvey API provides access to survey data, from listing all surveys to getting all the responses for a survey.","homepage_url":"https://www.smartsurvey.co.uk","id":"573cdf70def24f0e008e5857","is_migrated":false,"name":"SmartSurvey API","parent":null,"redirects":[],"sitemap":"disabled","subdomain":"smartsurvey","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[{"name":"Basic","scheme":"basic","source":"security","type":"http","id":"66b0f9c2bcbb29001805fa07"}],"webhooks":[],"custom_login":{"login_url":null,"logout_url":null},"features":{"custom_components":"disabled","mdx":"disabled"},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"logs":false,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"view":"public","password":null},"reference":{"api_sdk_snippets":"enabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"enabled","response_examples":"collapsed","response_schemas":"collapsed"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"startup","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2019-08-16T08:00:41.574Z"}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"disabled","custom_code":{"css":"enabled","html":"disabled","js":"disabled"}}},"appearance":{"brand":{"primary_color":"#ff6b00","link_color":null,"theme":"light"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"show"},"logo":{"size":"default","dark_mode":{"uri":null,"url":"https://files.readme.io/2d62df5-small-smartsurvey-logo-whiteout-large.png","name":"smartsurvey-logo-whiteout-large.png","width":308,"height":55,"color":"#ffffff","links":{"original_url":"https://files.readme.io/50be09b-smartsurvey-logo-whiteout-large.png"}},"main":{"uri":null,"url":"https://files.readme.io/c59d98f-small-smartsurvey-logo-on-white-large.png","name":"smartsurvey-logo-on-white-large.png","width":434,"height":80,"color":"#a6684a","links":{"original_url":"https://files.readme.io/3506a42-smartsurvey-logo-on-white-large.png"}},"favicon":{"uri":null,"url":"https://files.readme.io/7da1d2d-favicon.ico","name":"favicon.ico","width":32,"height":32,"color":"#000000","links":{"original_url":null}}},"custom_code":{"css":null,"js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"line","gradient_color":null,"overlay":{"fill":"auto","type":"triangles","position":"top-left","image":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}}},"navigation":{"first_page":"landing_page","left":[{"type":"home","title":null,"url":null,"custom_page":null},{"type":"guides","title":null,"url":null,"custom_page":null},{"type":"reference","title":null,"url":null,"custom_page":null}],"logo_link":"homepage","right":[],"sub_nav":[],"subheader_layout":"dropdown","version":"enabled","links":{"home":{"label":"Home","visibility":"disabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":null,"visibility":"enabled"},"reference":{"label":"API Reference","alias":null,"visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"disabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}}}},"version":{"_id":"573cdf70def24f0e008e585a","createdAt":"2016-05-18T21:32:32.372Z","is_deprecated":false,"is_hidden":false,"releaseDate":"2016-05-18T21:32:32.372Z","__v":13,"categories":["573cdf70def24f0e008e585b","573ce6c947337f0e00b6d87c","573d7f43e1ec4a2000e814a5","574b95216a29ec2200b74817","574c88905953e20e00f40f36","589c59b30552cc2f00a61cf7","58ece0c3dbdd4e2500ae1b6f","58ece2d765565b2d0044c802","5a0327754bd2620010a4d4e2","5a032bc84d876d0028c21a57","5a0cd760ddd9be00123df492","5a70a49d54f17a003acfa07d","5cb099c47fa53e00395b22d0","6376beff127d99000316be7c"],"codename":"","is_beta":false,"is_stable":true,"project":"573cdf70def24f0e008e5857","version":"1","version_clean":"1.0.0"}},"reqUrl":"/docs/getting-started","version":{"_id":"573cdf70def24f0e008e585a","createdAt":"2016-05-18T21:32:32.372Z","is_deprecated":false,"is_hidden":false,"releaseDate":"2016-05-18T21:32:32.372Z","__v":13,"categories":["573cdf70def24f0e008e585b","573ce6c947337f0e00b6d87c","573d7f43e1ec4a2000e814a5","574b95216a29ec2200b74817","574c88905953e20e00f40f36","589c59b30552cc2f00a61cf7","58ece0c3dbdd4e2500ae1b6f","58ece2d765565b2d0044c802","5a0327754bd2620010a4d4e2","5a032bc84d876d0028c21a57","5a0cd760ddd9be00123df492","5a70a49d54f17a003acfa07d","5cb099c47fa53e00395b22d0","6376beff127d99000316be7c"],"codename":"","is_beta":false,"is_stable":true,"project":"573cdf70def24f0e008e5857","version":"1","version_clean":"1.0.0"},"lang":"en","langFull":"Default","isDetachedProductionSite":false}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6859,1802,9772,3284,7449,7372,9082,572,5312,2406,2395,6522,7112,73,8263,1282,2852,3880,7783,1456,4935,6841,6722,1936,5798,8063,1080,1202,9852,8684,1666,4002,3787,7971,153,1313,1343,6060,6922,2859,2144,9141,2578,5408,2637,4674,1731,2616,3412,9575,3859,4467,2402,7031,3221,7327,7285,3307,4793,1948,678,8899,3556]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","core-icons-chevron-up-down-svg","routes-Doc","Footer","core-icons-arrow-up-right-svg","Editor","core-icons-alert-circle-svg","core-icons-x-circle-svg","core-icons-suggested-edits-svg","routes-PageNotFound","routes-Landing","routes-Reference","core-icons-more-vertical-svg","core-icons-lock-svg","CustomPage","routes-Changelog","Post","core-icons-eye-off-svg","routes-Discuss","List","core-icons-trending-up-svg","core-icons-callout-info-svg","core-icons-arrow-right-svg","core-icons-chevron-down-svg","routes-Tutorials","Page","core-icons-message-circle-svg","routes-CustomPage","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","core-icons-star-svg","rmdx","core-icons-webhook-svg","New","core-icons-key-svg"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.b8520cde412c1642dc0b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.1912e092b9c8785ff5c3.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3284.6ecd6ef27e2009d3fdc7.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/572.bab1eda8453360a8a761.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2406.951963c0cf542b4b86a4.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.6288c030d5183baa5a89.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7112.69c3d611e7e54e411b26.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/73.535ee2b3bfca871baf6d.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/8263.3d098f45b4b562ec80b5.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1282.591f476c316bf3670bbd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.49bb02ec5acf87fd228c.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/3880.3892311d81c548cb073c.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.48ca7ef3a5c469d97e53.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.9119a4e00e8cb781f8b7.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/6841.587d285d41ca8bab11b1.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/6722.386671bc80030984d9c0.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.e3a4e0817a9a640436bc.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.js"></script> <script async data-chunk="core-icons-arrow-up-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.a0c700eb9ae5192d6433.js"></script> <script async data-chunk="core-icons-alert-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"></script> <script async data-chunk="core-icons-x-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"></script> <script async data-chunk="core-icons-suggested-edits-svg" src="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/4002.08d1caef58d08eaccd19.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.4f1c8dfacfeed0a6ea87.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/7971.db270c2970b791e38435.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/153.e4db5a313c7d51383015.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.d66a49f09580aafdabb6.js"></script> <script async data-chunk="core-icons-more-vertical-svg" src="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"></script> <script async data-chunk="core-icons-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/2859.94b03b9a9585460aa921.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.18ddfae65f140c2e4c1e.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.cced33af5051de7f473f.js"></script> <script async data-chunk="core-icons-eye-off-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"></script> <script async data-chunk="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.3a8d675d9cf79a25b071.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/2637.a5df1d5e240762d7981f.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/4674.13378da16ce7b5beba66.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.12cee315afa198c8e23e.js"></script> <script async data-chunk="core-icons-trending-up-svg" src="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"></script> <script async data-chunk="core-icons-callout-info-svg" src="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"></script> <script async data-chunk="core-icons-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"></script> <script async data-chunk="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.8adf2bf8562dfeff14b4.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.65c6f721688901333944.js"></script> <script async data-chunk="core-icons-message-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"></script> <script async data-chunk="core-icons-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.3337538299592ef842e6.js"></script> <script async data-chunk="core-icons-star-svg" src="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"></script> <script async data-chunk="rmdx" src="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"></script> <script async data-chunk="core-icons-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"></script> <script async data-chunk="New" src="https://cdn.readme.io/public/hub/web/New.908bc26e77bebc585452.js"></script> <script async data-chunk="core-icons-key-svg" src="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"></script></div><script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); </script><script>ga('create', 'UA-377167-1', 'auto', {'name': 'custom'}); $(window).on('pageLoad', function(e, state){ ga('custom.send', 'pageview', window.location.pathname); }); </script><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"MmIyZGZiYTY4MzYyODcwZmE0YjMzYmJjMjhjNzA2MjU0MmFhZTI2MWU1YzE0MjY3MmUwNDBmNTExMTY4MGU2NnRhZ0ZpbHRlcnM9KHByb2plY3Q6NTczY2RmNzBkZWYyNGYwZTAwOGU1ODU3KSwodmVyc2lvbjpub25lLHZlcnNpb246NTczY2RmNzBkZWYyNGYwZTAwOGU1ODVhKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ==","filters":"tagFilters=(project:573cdf70def24f0e008e5857),(version:none,version:573cdf70def24f0e008e585a),(hidden:none,hidden:false),(index:CustomPage,index:Page)","metaData":[{"modules":{"landing":false,"discuss":false,"reference":true,"examples":true,"docs":true,"suggested_edits":true,"changelog":false,"logs":false,"custompages":false,"tutorials":false,"graphql":false},"id":"573cdf70def24f0e008e5857","name":"SmartSurvey API","subdomain":"smartsurvey","subpath":"","nav_names":{"docs":"","discuss":"","reference":"","changelog":"","tutorials":"","recipes":""}}]}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>