CINXE.COM
Introduction
<!DOCTYPE html><html lang="en" style="" data-color-mode="system" class=" useReactApp isRefPage "><head><script src="https://cdn.readme.io/public/js/force-firefox-anchor-jump.js?1732290089794"></script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="readme-deploy" content="5.235.0"><meta name="readme-subdomain" content="fairing"><meta name="readme-version" content="1.0"><title>Introduction</title><meta name="description" content="An introduction to the Fairing (formerly EnquireLabs) API."><meta property="og:title" content="Introduction"><meta property="og:description" content="An introduction to the Fairing (formerly EnquireLabs) API."><meta property="og:site_name" content="Fairing"><meta name="twitter:title" content="Introduction"><meta name="twitter:description" content="An introduction to the Fairing (formerly EnquireLabs) 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/f01dca6-fairing-logo-h-24px.svg"><meta name="twitter:image" content="https://files.readme.io/f01dca6-fairing-logo-h-24px.svg"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/f6dd52b-small-Logo-Turquoise.png" type="image/png"><link rel="canonical" href="https://docs.fairing.co/reference/api"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1732290089794"></script><link data-chunk="New" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/New.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="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.394c4b2f8910cf363781.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.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="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.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="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.c5ea43d2f4b3b926ff1f.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-PageNotFound" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.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.db8b3beb03eead84c21e.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.a5d24742a3656724b61d.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.766cf20fa350c2c18107.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/5548.8fb1bb5d57de6c263c67.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/4608.3b5a227647e78e858c3f.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8263.a563779273b90f66c0db.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.a3bb3020bf29f8f67ef8.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.ad57d9fcd570c04fb712.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="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.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-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/6722.e485c5aa155bd0f0ccf8.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="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.f0816876bdfbbc06801a.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-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/routes-Doc.e3a4e0817a9a640436bc.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-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-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="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.3f125a62ed05cc53aec4.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-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.002979730c36f9c65ad3.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-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.6a5b69949f194448cf4f.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-webhook-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.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-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.5ccfbee71da134a1eeba.js"> <link data-chunk="rmdx" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.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="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-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="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="New" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/New.908bc26e77bebc585452.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="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-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.a5d24742a3656724b61d.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.db8b3beb03eead84c21e.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.c5ea43d2f4b3b926ff1f.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.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.394c4b2f8910cf363781.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.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:#0265DE;--project-color-inverse:#fff;--recipe-button-color:#0265DE;--recipe-button-color-hover:#013779;--recipe-button-color-active:#012046;--recipe-button-color-focus:rgba(2, 101, 222, 0.25);--recipe-button-color-disabled:#aed2fe}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#0265DE;--project-color-inverse:#fff}a{color:var(--color-link-primary,#0265de)}a:hover{color:var(--color-link-primary-darken-5,#013779)}a.text-muted:hover{color:var(--color-link-primary,#0265de)}.btn.btn-primary{background-color:#0265de}.btn.btn-primary:hover{background-color:#013779}.theme-line #hub-landing-top h2{color:#0265de}#hub-landing-top .btn:hover{color:#0265de}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#0265de}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#0265de,#004293)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(undefined)}.theme-line header#hub-header #header-top{border-bottom-color:#0265de}.theme-line header#hub-header #header-top .btn{background-color:#0265de}header#hub-header #header-top #header-logo{width:82px;height:24px;margin-top:8px;background-image:url(https://files.readme.io/f01dca6-fairing-logo-h-24px.svg)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#0265de}#subheader-links a.active{color:#0265de!important;box-shadow:inset 0 -2px 0 #0265de}#subheader-links a:hover{color:#0265de!important;box-shadow:inset 0 -2px 0 #0265de;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#0265de}section#hub-discuss .discussion a .discuss-body h4{color:#0265de}section#hub-discuss .discussion a:hover .discuss-body h4{color:#013779}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#0265de}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#0265de}#hub-search-results h3 em{color:#0265de}.main_background,.tag-item{background:#0265de!important}.main_background:hover{background:#013779!important}.main_color{color:#0265de!important}.border_bottom_main_color{border-bottom:2px solid #0265de}.main_color_hover:hover{color:#0265de!important}section#hub-discuss h1{color:#0265de}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#0265de;background-color:#0265de}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#013779;border-color:#013779}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#0265de;color:#0265de}#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,#0265de);border-color:var(--project-color-primary,#0265de)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#013779;border-color:#013779}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#0265de;fill:var(--project-color-primary,#0265de)}#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:#0265de}.main-color-accent{border-bottom:3px solid #0265de;padding-bottom:8px}</style><meta name="loadedProject" content="fairing"><script>var storedColorMode = `system` === 'system' ? window.localStorage.getItem('color-scheme') : `system` 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.235.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-none theme-line header-solid header-bg-size-auto header-bg-pos-tl header-overlay-triangles reference-layout-row lumosity-normal hub-full"><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark ThemeContext_line" style="--color-primary:#0265DE;--color-primary-inverse:#fff;--color-primary-alt:#004293;--color-primary-darken-10:#024eab;--color-primary-darken-20:#013779;--color-primary-alpha-25:rgba(2, 101, 222, 0.25);--color-link-primary:#0265DE;--color-link-primary-darken-5:#0259c5;--color-link-primary-darken-10:#024eab;--color-link-primary-darken-20:#013779;--color-link-primary-alpha-50:rgba(2, 101, 222, 0.5);--color-link-primary-alpha-25:rgba(2, 101, 222, 0.25);--color-link-background:rgba(2, 101, 222, 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://fairing.co/" target="_self"><img alt="Fairing" class="rm-Logo-img rm-Logo-img_lg Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/f01dca6-fairing-logo-h-24px.svg"/></a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://fairing.canny.io/changelog" target="_self" to="https://fairing.canny.io/changelog">Changelog</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://status.fairing.co" target="_self" to="https://status.fairing.co">Status</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 class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Documentation</span></a><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/reference" target="_self"><i class="icon-references NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">API Reference</span></a><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://fairing.canny.io/changelog" rel="noopener" target="_blank" to="https://fairing.canny.io/changelog">Changelog</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://status.fairing.co" rel="noopener" target="_blank" to="https://status.fairing.co">Status</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://docs.fairing.co/page/support" rel="noopener" target="_blank" to="https://docs.fairing.co/page/support">Contact Us</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="https://fairing.co/" target="_self"><img alt="Fairing" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/f01dca6-fairing-logo-h-24px.svg"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-references Header-left-nav-icon10glJKFwewOv"></i>API Reference</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://docs.fairing.co/page/support" target="_self" to="https://docs.fairing.co/page/support">Contact Us</a></span><div class="ThemeToggle-wrapper1M_iJESXCpGR Dropdown Dropdown_closed"><button aria-label="Toggle to light mode" id="ThemeToggle-button-static-id-placeholder" aria-haspopup="dialog" class="Button Button_slate_text Button_sm rm-ThemeToggle ThemeToggle2tVPbUyQbWDo Dropdown-toggle Button_primary" type="button"><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv " role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Moon (Dark Mode)</title><path d="M19 14.79C18.8427 16.4922 18.2039 18.1144 17.1582 19.4668C16.1126 20.8192 14.7035 21.8458 13.0957 22.4265C11.4879 23.0073 9.74798 23.1181 8.0795 22.7461C6.41102 22.3741 4.88299 21.5345 3.67423 20.3258C2.46546 19.117 1.62594 17.589 1.25391 15.9205C0.881876 14.252 0.992717 12.5121 1.57346 10.9043C2.1542 9.29651 3.18083 7.88737 4.53321 6.84175C5.8856 5.79614 7.5078 5.15731 9.21 5C8.21341 6.34827 7.73385 8.00945 7.85853 9.68141C7.98322 11.3534 8.70386 12.9251 9.8894 14.1106C11.0749 15.2961 12.6466 16.0168 14.3186 16.1415C15.9906 16.2662 17.6517 15.7866 19 14.79Z"></path><path class="ThemeToggle-Icon-star3wweJby1gM4w" d="M18.3707 1C18.3707 3.22825 16.2282 5.37069 14 5.37069C16.2282 5.37069 18.3707 7.51313 18.3707 9.74138C18.3707 7.51313 20.5132 5.37069 22.7414 5.37069C20.5132 5.37069 18.3707 3.22825 18.3707 1Z"></path></svg><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv ThemeToggle-Icon_active18I2-19CkbgD" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Sun (Light Mode)</title><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 1V3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 5.64L19.78 4.22"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M21 12H23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 18.36L19.78 19.78"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 21V23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 19.78L5.64 18.36"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M1 12H3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 4.22L5.64 5.64"></path><path d="M12 17C14.7614 17 17 14.7614 17 12C17 9.23858 14.7614 7 12 7C9.23858 7 7 9.23858 7 12C7 14.7614 9.23858 17 12 17Z"></path></svg></button></div><div class="Header-searchtb6Foi0-D9Vx"><button aria-label="Search" 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"><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/docs" target="_self"><i class="icon-guides"></i><span>Documentation</span></a><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active" href="/reference" target="_self"><i class="icon-references"></i><span>API Reference</span></a></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">Introduction</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" 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-ReferenceMain rm-Container rm-Container_flex rm-basic-page loading" id="Explorer"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj" id="reference-sidebar"><div class="Main-QuickNav-container1OiLvjSDusO6"><button aria-keyshortcuts="Control+/ Meta+/" class="QuickNav1q-OoMjiX_Yr QuickNav-button2KzlQbz5Pm2Y">JUMP TO</button></div><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Fairing 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="/reference/api"><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="/reference/authentication"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Authentication</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/question-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Questions" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Questions</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/question-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">The question object</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/retrieve-questions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">List all questions</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/the-response-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Responses" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Responses</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/the-response-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">The response object</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/retrieve-responses"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">List all responses</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li></ul></section><div class="readme-logo" id="readmeLogo">Powered by <a aria-label="ReadMe" href="https://readme.com?ref_src=hub&project=fairing" 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 class="headline-container21aRBSn8Bqg6 headline-container_basic1DFntTggitfX" data-raycast-oas="false"><div class="headline-container-grid-itemGdPV-VbhShYs button-containerobFfV0vf6giV"><div class="reference-flyout"><button aria-label="Toggle reference sidebar" class="icon-menu reference-sidebar-mobile-button26mqim6Chewq reference-sidebar-mobile-button_singleCol1Jam1HM1TS00" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj mobile" id="reference-sidebar"><div class="ref-QuickNav-mobile-containerARtvyEDVpRhW"><button aria-keyshortcuts="Control+/ Meta+/" class="QuickNav1q-OoMjiX_Yr QuickNav-button2KzlQbz5Pm2Y">JUMP TO</button></div><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Fairing 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="/reference/api"><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="/reference/authentication"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Authentication</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/question-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Questions" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Questions</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/question-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">The question object</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/retrieve-questions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">List all questions</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/the-response-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Responses" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Responses</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/the-response-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">The response object</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/retrieve-responses"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">List all responses</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li></ul></section><div class="readme-logo" id="readmeLogo">Powered by <a aria-label="ReadMe" href="https://readme.com?ref_src=hub&project=fairing" style="color:unset"><i class="icon icon-readme" style="display:inline-block;min-width:71px"></i></a></div></div></nav></div></div></div><header id="content-head"><h1>Introduction</h1></header></div><div role="doc-subtitle" class="rm-Markdown markdown-body undefined excerptT2m-MzSJGRK7" data-testid="RDMD"><p>An introduction to the Fairing (formerly EnquireLabs) API.</p></div></header><div class="rm-Markdown markdown-body content-body" data-testid="RDMD"><p>The Fairing API allows you to programmatically fetch your questions and response data. It is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.</p> <div class="rdmd-html">If you're a technology partner integrating our API, <span class="signup__help-action" onclick="Intercom('showNewMessage')"><a href="">let us know</a></span> and we'll add you to our documentation. </div></div></article><section class="content-toc grid-25"></section><div class="ModalWrapper" id="response-headers-modal-root"></div><div class="ModalWrapper" id="tutorialmodal-root"></div><div class="ModalWrapper QuickNav-modal QuickNav-modal-desktop" id="QuickNav-modal-root"></div><div class="ModalWrapper QuickNav-modal QuickNav-modal-mobile" id="QuickNav-mobile-modal-root"></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":"5f9c809a8a28490012254350","title":"Welcome to Fairing","slug":"documentation","order":0,"reference":false,"isAPI":false,"version":"5f9c809a8a2849001225434e","project":"5f9c809a8a28490012254347","createdAt":"2020-10-30T21:07:38.539Z","__v":0,"pages":[{"_id":"5fa02ab8e5f0dd002c63717d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Introduction","type":"basic","slug":"welcome","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-02T15:50:16.065Z","category":"5f9c809a8a28490012254350","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5fa158c19544d0002e4becac","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"FAQs - Troubleshoot","type":"basic","slug":"faqs","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-03T13:18:57.860Z","category":"5f9c809a8a28490012254350","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"6585b820f9e20500559914f3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Debugger","icon":"","type":"basic","slug":"debugger","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa158c19544d0002e4becac","category":"5f9c809a8a28490012254350","createdAt":"2023-12-22T16:24:00.744Z","isBodyEmpty":false,"children":[]}]},{"_id":"64cd2daa75e28e00461d7f0e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Accessibility Statement","icon":"","type":"basic","slug":"accessibility-statement","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"accessibility-statement-for-fairing","category":"5f9c809a8a28490012254350","createdAt":"2023-08-04T16:56:10.726Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"614249d5c18e5500792e9494","title":"Quick Start","slug":"quick-start","order":1,"reference":false,"isAPI":false,"project":"5f9c809a8a28490012254347","version":"5f9c809a8a2849001225434e","createdAt":"2021-09-15T19:30:29.165Z","__v":0,"pages":[{"_id":"614249daa0b594022a345429","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Shopify","type":"basic","slug":"shopify","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-09-15T19:30:34.678Z","category":"614249d5c18e5500792e9494","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"651344e7124371007a5098c0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Shopify Checkout Extensibility","icon":"","type":"basic","slug":"shopify-checkout-extensions","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"614249daa0b594022a345429","category":"614249d5c18e5500792e9494","createdAt":"2023-09-26T20:53:59.760Z","isBodyEmpty":false,"children":[]},{"_id":"64c958dd06c90b004b2a3217","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Shopify Point-of-Sale (POS)","icon":"","type":"basic","slug":"point-of-sale-shopify","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"614249d5c18e5500792e9494","createdAt":"2023-08-01T19:11:25.072Z","parentDoc":"614249daa0b594022a345429","isBodyEmpty":false,"children":[]},{"_id":"614249019167d10072098829","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Look And Feel","type":"basic","slug":"look-and-feel","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-09-15T19:26:57.635Z","category":"614249d5c18e5500792e9494","parentDoc":"614249daa0b594022a345429","deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"619678c0bb921d003013b939","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Custom Question Stream Location","type":"basic","slug":"question-stream-custom-location","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"question-stream-location","createdAt":"2021-11-18T16:01:04.298Z","parentDoc":"614249019167d10072098829","category":"614249d5c18e5500792e9494","icon":"","isBodyEmpty":false,"children":[]},{"_id":"621502e49500ff05050588c6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Full-Page Takeover (Advanced)","type":"basic","slug":"full-page-takeover-advanced","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-02-22T15:36:04.919Z","parentDoc":"614249019167d10072098829","category":"614249d5c18e5500792e9494","icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"6196bfa2bffcef002cc1fc86","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Headless Integration","type":"basic","slug":"headless-integration","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"headless-integration1","parentDoc":"614249daa0b594022a345429","createdAt":"2021-11-18T21:03:30.397Z","category":"614249d5c18e5500792e9494","icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"614249df9abefc001408fa3c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Custom Snippet","type":"basic","slug":"sdk","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"sdk-1","createdAt":"2021-09-15T19:30:39.555Z","category":"614249d5c18e5500792e9494","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"62ab9d68bc151f001ae9fdec","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Events","type":"basic","slug":"events","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-06-16T21:15:20.209Z","category":"614249d5c18e5500792e9494","parentDoc":"614249df9abefc001408fa3c","icon":"","isBodyEmpty":false,"children":[]},{"_id":"664680d00c575500697182a1","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Sample Question Stream HTML","icon":"","type":"basic","slug":"sample-question-stream-html","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"614249df9abefc001408fa3c","category":"614249d5c18e5500792e9494","createdAt":"2024-05-16T21:55:28.427Z","isBodyEmpty":false,"children":[]}]},{"_id":"64640cdd00e6a8000a6d33f0","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Salesforce Commerce Cloud","icon":"","type":"basic","slug":"salesforce-commerce-cloud","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"614249d5c18e5500792e9494","createdAt":"2023-05-16T23:08:13.908Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64b01721068aa7155a6a994b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"WooCommerce","icon":"","type":"basic","slug":"woocommerce","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"614249d5c18e5500792e9494","createdAt":"2023-07-13T15:24:17.812Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6234ecb0350c8c022e134a32","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"API","type":"link","slug":"api-1","order":10,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://docs.fairing.co/docs/api","link_external":true,"previousSlug":"","createdAt":"2022-03-18T20:33:52.981Z","category":"614249d5c18e5500792e9494","parentDoc":null,"icon":"","isBodyEmpty":true,"children":[]},{"_id":"636dc7cd2333a30030222373","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Question Bank","icon":"","type":"basic","slug":"question-bank","order":11,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"question-bank-1","createdAt":"2022-11-11T03:55:57.233Z","category":"614249d5c18e5500792e9494","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"611d15894b2b1000100bb85c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Example Questions","type":"basic","slug":"question-bank-archive","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"question-bank","createdAt":"2021-08-18T14:13:29.681Z","parentDoc":"636dc7cd2333a30030222373","category":"614249d5c18e5500792e9494","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"632c778475842a0010df2637","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"User Accounts","icon":"","type":"basic","slug":"user-accounts","order":12,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-09-22T14:56:04.954Z","category":"614249d5c18e5500792e9494","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"61424894389be2012719f36f","title":"Question Stream™","slug":"question-stream","order":2,"reference":false,"isAPI":false,"project":"5f9c809a8a28490012254347","version":"5f9c809a8a2849001225434e","createdAt":"2021-09-15T19:25:08.469Z","__v":0,"pages":[{"_id":"61424a308b07ed004ee7a3dd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Functionality","type":"basic","slug":"question-stream-functionality","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"question-stream-functionality1","parentDoc":null,"createdAt":"2021-09-15T19:32:00.982Z","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"6196c163da1929000ffb21f7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Previewing Your Survey","type":"basic","slug":"previewing-your-survey","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"previewing-your-survey1","parentDoc":"61424a308b07ed004ee7a3dd","createdAt":"2021-11-18T21:10:59.241Z","category":"61424894389be2012719f36f","icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"61424aa70ed20100789e105e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Creating & Editing Questions","type":"basic","slug":"creating-and-editing-questions","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"creating-editing-questions1","parentDoc":null,"createdAt":"2021-09-15T19:33:59.347Z","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"61439ef77659640012554f82","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Response Clarification (2-step)","type":"basic","slug":"response-clarification","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"response-clarification-2-step1111","createdAt":"2021-09-16T19:45:59.164Z","category":"61424894389be2012719f36f","parentDoc":"61424aa70ed20100789e105e","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"64666992da244900275c8362","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Auto Advance","icon":"","type":"basic","slug":"auto-advance","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"61424aa70ed20100789e105e","category":"61424894389be2012719f36f","createdAt":"2023-05-18T18:08:18.918Z","isBodyEmpty":false,"children":[]},{"_id":"6155d4fd197c7900466959f6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Randomize Response Options","type":"basic","slug":"randomization-of-responses","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-09-30T15:17:17.034Z","parentDoc":"61424aa70ed20100789e105e","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"646e6e9e25ce3c000ae126d3","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Question Targeting Rules","icon":"","type":"basic","slug":"question-targeting-rules","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"61424aa70ed20100789e105e","category":"61424894389be2012719f36f","createdAt":"2023-05-24T20:07:58.890Z","isBodyEmpty":false,"children":[{"_id":"647621b141101e000c2e5ff0","api":{"method":"get","url":"","auth":"required","params":[]},"title":"New vs Returning","icon":"","type":"basic","slug":"new-vs-returning","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"646e6e9e25ce3c000ae126d3","category":"61424894389be2012719f36f","createdAt":"2023-05-30T16:17:53.203Z","isBodyEmpty":false,"children":[]},{"_id":"647621c1c7d148001f6e6617","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Geographic Location","icon":"","type":"basic","slug":"customer-location","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"646e6e9e25ce3c000ae126d3","category":"61424894389be2012719f36f","createdAt":"2023-05-30T16:18:09.642Z","isBodyEmpty":false,"children":[]},{"_id":"647621cff7a283000c25a09b","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Products Purchased","icon":"","type":"basic","slug":"products-purchased","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"646e6e9e25ce3c000ae126d3","category":"61424894389be2012719f36f","createdAt":"2023-05-30T16:18:23.705Z","isBodyEmpty":false,"children":[]},{"_id":"64763f7f20bd4f004f9c1504","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Question Frequency","icon":"","type":"basic","slug":"question-frequency","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"frequency","parentDoc":"646e6e9e25ce3c000ae126d3","category":"61424894389be2012719f36f","createdAt":"2023-05-30T18:25:03.145Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"61b27a24e65e5c002cd8e0d2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Custom Success Message","type":"basic","slug":"success-message","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-12-09T21:50:28.156Z","parentDoc":null,"category":"61424894389be2012719f36f","icon":"","isBodyEmpty":false,"children":[]},{"_id":"6196b30fe3978e0041be250d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Analytics","type":"basic","slug":"analytics","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"analytics1","createdAt":"2021-11-18T20:09:51.707Z","category":"61424894389be2012719f36f","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[{"_id":"64c147526fcf1c002aee7f56","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Time Series Analytics","icon":"","type":"basic","slug":"time-series-analytics","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6196b30fe3978e0041be250d","category":"61424894389be2012719f36f","createdAt":"2023-07-26T16:18:26.321Z","isBodyEmpty":false,"children":[]},{"_id":"647613d655e116000a105112","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Comparison Analytics","icon":"","type":"basic","slug":"comparison-analytics","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6196b30fe3978e0041be250d","category":"61424894389be2012719f36f","createdAt":"2023-05-30T15:18:46.755Z","isBodyEmpty":false,"children":[]},{"_id":"64cbc87fd304950af8f721dd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"NPS Analytics","icon":"","type":"basic","slug":"nps-reporting","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6196b30fe3978e0041be250d","category":"61424894389be2012719f36f","createdAt":"2023-08-03T15:32:15.654Z","isBodyEmpty":false,"children":[]},{"_id":"6196b3a329345900486ebc5e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Response Clarification Analytics","type":"basic","slug":"response-clarification-analytics","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"response-clarification-analytics1","parentDoc":"6196b30fe3978e0041be250d","createdAt":"2021-11-18T20:12:19.190Z","category":"61424894389be2012719f36f","icon":"","isBodyEmpty":false,"children":[]},{"_id":"632865b852afa700803cf79d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Extrapolated Count & Revenue","icon":"","type":"basic","slug":"extrapolation","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"extrapolation-of-response-data","createdAt":"2022-09-19T12:51:04.554Z","parentDoc":"6196b30fe3978e0041be250d","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"664e4da247da2f005b54f3da","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Last Click Report","icon":"","type":"basic","slug":"insights","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6196b30fe3978e0041be250d","category":"61424894389be2012719f36f","createdAt":"2024-05-22T19:55:14.385Z","isBodyEmpty":false,"children":[]},{"_id":"664e5551442cd20061160f7f","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Discount Code Report","icon":"","type":"basic","slug":"discount-code-report","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6196b30fe3978e0041be250d","category":"61424894389be2012719f36f","createdAt":"2024-05-22T20:28:01.769Z","isBodyEmpty":false,"children":[]}]},{"_id":"61eabb9b2213ae03b3e7d6c7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Responses","type":"basic","slug":"responses-page-1","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-21T13:56:43.190Z","category":"61424894389be2012719f36f","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[{"_id":"638e5ac82fb03f004007f5c0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Response Recategorization","icon":"","type":"basic","slug":"response-recategorization","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"response-reclassification","createdAt":"2022-12-05T20:55:36.054Z","parentDoc":"61eabb9b2213ae03b3e7d6c7","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"61424c7159f96d000f90c21b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Exporting Your Data","type":"basic","slug":"exporting-your-data","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"exporting-your-data1","createdAt":"2021-09-15T19:41:37.766Z","category":"61424894389be2012719f36f","parentDoc":"61eabb9b2213ae03b3e7d6c7","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"664e1b003ecc59005609bd22","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Lifetime Value Analytics","icon":"","type":"basic","slug":"lifetime-value-analytics","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"lifetime-value-reports","category":"61424894389be2012719f36f","createdAt":"2024-05-22T16:19:12.172Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64cbc7c4ab991c0b929b790b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Customer View","icon":"","type":"basic","slug":"customer-view","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"61424894389be2012719f36f","createdAt":"2023-08-03T15:29:08.653Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64c15dddda74d20049ad1a3b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Live Feed","icon":"","type":"basic","slug":"live-feed","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"61424894389be2012719f36f","createdAt":"2023-07-26T17:54:37.581Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"65b2c5b78dac5c007319bfbb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Language Translations","icon":"","type":"basic","slug":"language-translations","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"61424894389be2012719f36f","createdAt":"2024-01-25T20:33:59.387Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5fa0326f5c4e7600479d4a31","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Integrations Catalog","type":"basic","slug":"integrations-catalog","order":10,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-02T16:23:11.592Z","category":"61424894389be2012719f36f","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"6000b601744332007d7893a9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Alloy","type":"basic","slug":"alloy","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-01-14T21:22:09.794Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"609a883c437af7005a11d7d8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Daasity","type":"basic","slug":"daasity","order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","createdAt":"2021-05-11T13:35:56.866Z","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"62feb9cc4bfc2400210f125e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Daton by Saras Analytics","icon":"","type":"basic","slug":"daton","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"saras-analytics","createdAt":"2022-08-18T22:14:36.673Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"659714b2a1dfab0016cd1a22","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Disco","icon":"","type":"basic","slug":"disco","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2024-01-04T20:27:30.932Z","isBodyEmpty":true,"children":[]},{"_id":"611fa975620e55005b08f922","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Elevar","type":"basic","slug":"elevar","order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-08-20T13:09:09.591Z","category":"61424894389be2012719f36f","parentDoc":"5fa0326f5c4e7600479d4a31","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"638e4d71da5785006ee8f9ba","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Funnel","icon":"","type":"basic","slug":"funnel","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"funnelio","createdAt":"2022-12-05T19:58:41.748Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"5fa05acc1cb0e00035626cb9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Google Analytics (GA4)","type":"basic","slug":"google-analytics-4","order":8,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"google-analytics","createdAt":"2020-11-02T19:15:24.406Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"63ca8e1a1df82c00823d596c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Google Sheets Extension","icon":"","type":"basic","slug":"google-sheets","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-01-20T12:50:34.734Z","isBodyEmpty":false,"children":[]},{"_id":"611fa9986bdb56024c874200","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Google Tag Manager","type":"basic","slug":"google-tag-manager","order":10,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-08-20T13:09:44.800Z","category":"61424894389be2012719f36f","parentDoc":"5fa0326f5c4e7600479d4a31","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"64f72e48465231102c6f60c4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Klar","icon":"","type":"basic","slug":"klar","order":11,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-09-05T13:34:00.309Z","isBodyEmpty":false,"children":[]},{"_id":"5fa05ac28fb1ef0018c31382","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Klaviyo","type":"basic","slug":"klaviyo","order":12,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-02T19:15:14.518Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"638e4d60a994d1002ee636e9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Measured","icon":"","type":"basic","slug":"measured","order":13,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-12-05T19:58:24.137Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"62b35661a3f3f8005055c73d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Peel","type":"basic","slug":"peel","order":15,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-06-22T17:50:25.051Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","icon":"","isBodyEmpty":false,"children":[]},{"_id":"655d1ed8259d1b001273d6c4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Podscribe","icon":"","type":"basic","slug":"podscribe","order":16,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-11-21T21:19:20.897Z","isBodyEmpty":false,"children":[]},{"_id":"5fa05ae0e29f6b00434b4605","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Recharge","type":"basic","slug":"recharge","order":17,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-02T19:15:44.482Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5fa05ae97145480052ffd8b7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Rockerbox","type":"basic","slug":"rockerbox","order":18,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-02T19:15:53.537Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"640fced8946f1800291037a7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Segment","icon":"","type":"basic","slug":"segment","order":19,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-03-14T01:33:12.845Z","isBodyEmpty":false,"children":[]},{"_id":"5fa07879f5bb2e006590128c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Shopify Flow","type":"basic","slug":"shopify-flow","order":20,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-02T21:22:01.374Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"63f8d03a5e45e0007318e91f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Source Medium","icon":"","type":"basic","slug":"source-medium","order":21,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-02-24T14:56:58.872Z","isBodyEmpty":false,"children":[]},{"_id":"63dd397aad9f8f0050c43567","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"TikTok","icon":"","type":"basic","slug":"tiktok","order":22,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-02-03T16:42:34.478Z","isBodyEmpty":false,"children":[]},{"_id":"61d72d38a7cda302ae333ab6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Triple Whale","type":"basic","slug":"triple-whale","order":23,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"triple-whale1","parentDoc":"5fa0326f5c4e7600479d4a31","createdAt":"2022-01-06T17:56:08.597Z","category":"61424894389be2012719f36f","icon":"","isBodyEmpty":false,"children":[]},{"_id":"651c38fc8982560049e6112d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Yotpo SMS & Email","icon":"","type":"basic","slug":"yotpo","order":24,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-10-03T15:53:32.796Z","isBodyEmpty":false,"children":[]},{"_id":"63ebfd8a178d63054682dbc8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Wonderment","icon":"","type":"basic","slug":"wonderment","order":25,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-02-14T21:30:50.043Z","isBodyEmpty":true,"children":[]}]},{"_id":"63506c7d79803a001e04dd91","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Data Sync","icon":"","type":"basic","slug":"data-sync","order":11,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:30:37.737Z","category":"61424894389be2012719f36f","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"63506deead645100602f19ff","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"AWS S3","icon":"","type":"basic","slug":"aws-s3","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:36:46.523Z","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"63506e057786260090ed16b9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"BigQuery","icon":"","type":"basic","slug":"bigquery","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:37:09.808Z","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"63506e3ca0550d0561eea1ad","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Google Cloud Storage (GCS)","icon":"","type":"basic","slug":"google-cloud-storage-gcs","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:38:04.706Z","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"63506e450df39b00338b3619","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"MySQL","icon":"","type":"basic","slug":"mysql","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:38:13.786Z","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"63506e4fdbb3b500866d7286","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Postgres","icon":"","type":"basic","slug":"postgres","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:38:23.825Z","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"63506e67e0dc4b003aba8d85","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Redshift","icon":"","type":"basic","slug":"redshift","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:38:47.751Z","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"63506e852bbca6009df72f70","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Snowflake","icon":"","type":"basic","slug":"snowflake","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:39:17.347Z","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"6617f40f3b1d3200100fb639","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Data Dictionary","icon":"","type":"basic","slug":"data-dictionary","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","createdAt":"2024-04-11T14:30:39.022Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"5fa0318c300535004df4438b","title":"Resources","slug":"resources","order":4,"reference":false,"isAPI":false,"project":"5f9c809a8a28490012254347","version":"5f9c809a8a2849001225434e","createdAt":"2020-11-02T16:19:24.588Z","__v":0,"pages":[{"_id":"5fad84a86ba1e80019c59fa7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Under The Hood","type":"basic","slug":"how-does-fairing-work","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"how-does-enquirelabs-work","createdAt":"2020-11-12T18:53:28.768Z","parentDoc":null,"category":"5fa0318c300535004df4438b","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5fa438c4b51f94001878b15b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Optimizing Your Survey","type":"basic","slug":"optimizing-your-survey","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-05T17:39:16.823Z","category":"5fa0318c300535004df4438b","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"5fa43ab094dab80011856ff8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"How Load Time Affects Response Rates","type":"basic","slug":"how-load-time-affects-your-survey-completion-rate","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-05T17:47:28.168Z","parentDoc":"5fa438c4b51f94001878b15b","category":"5fa0318c300535004df4438b","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5fa43ad048ac140036657b51","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"How Many Options is Optimal For Survey Completion?","type":"basic","slug":"how-many-options-is-optimal-for-survey-completion","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-05T17:48:00.163Z","parentDoc":"5fa438c4b51f94001878b15b","category":"5fa0318c300535004df4438b","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"66e08c26f21ab700611c0c05","api":{"method":"get","url":"","auth":"required","params":[]},"title":"How Question Rank Affects Response Rates","icon":"","type":"basic","slug":"how-question-rank-affects-response-rate","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa438c4b51f94001878b15b","category":"5fa0318c300535004df4438b","createdAt":"2024-09-10T18:12:54.375Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"619e689de5d14a03042fb4e5","title":"Shopify Flow","slug":"shopify-flow","order":5,"reference":false,"isAPI":false,"project":"5f9c809a8a28490012254347","version":"5f9c809a8a2849001225434e","createdAt":"2021-11-24T16:30:21.173Z","__v":0,"pages":[{"_id":"63a0904aa93c95004adbea37","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Shopify Flow Examples","icon":"","type":"basic","slug":"shopify-flow-examples","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"619e689de5d14a03042fb4e5","createdAt":"2022-12-19T16:24:42.034Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"619e68a6e65711004f6619a6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Google Sheets","type":"basic","slug":"add-responses-to-google-sheets-using-shopify-flow","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"google-sheets","createdAt":"2021-11-24T16:30:30.203Z","category":"619e689de5d14a03042fb4e5","parentDoc":"63a0904aa93c95004adbea37","icon":"","isBodyEmpty":false,"children":[]},{"_id":"61a4f0b9f856270033391db3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Slack","type":"basic","slug":"send-responses-to-slack-using-shopify-flow","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"slack","createdAt":"2021-11-29T15:24:41.306Z","category":"619e689de5d14a03042fb4e5","parentDoc":"63a0904aa93c95004adbea37","icon":"","isBodyEmpty":false,"children":[]},{"_id":"61a4fa3d0fc9bb0029d98c9d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Tag Customers & Orders","type":"basic","slug":"tag-customers-and-orders-with-response-data","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"tag-customers-orders","createdAt":"2021-11-29T16:05:17.015Z","category":"619e689de5d14a03042fb4e5","parentDoc":"63a0904aa93c95004adbea37","icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"61a4e7bde1943f002e59d318","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"HTTP Request","type":"basic","slug":"exporting-to-database-shopify-flow","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-11-29T14:46:21.512Z","category":"619e689de5d14a03042fb4e5","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[{"_id":"61a4e7d4f45cd0005bdc333e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Stitchdata","type":"basic","slug":"export-using-shopify-flow-and-stitchdata","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"export-using-shopify-flow-legacy","parentDoc":"61a4e7bde1943f002e59d318","createdAt":"2021-11-29T14:46:44.981Z","category":"619e689de5d14a03042fb4e5","icon":"","isBodyEmpty":false,"children":[]},{"_id":"61a4ea5616e1e3000f8fe96a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Fivetran","type":"basic","slug":"export-using-shopify-flow-and-fivetran","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"export-using-shopify-flow-and-fivetran1-1","parentDoc":"61a4e7bde1943f002e59d318","createdAt":"2021-11-29T14:57:26.593Z","category":"619e689de5d14a03042fb4e5","icon":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"5fa158f705478c0012bd39d3","title":"Tutorials","slug":"tutorials","order":6,"reference":false,"isAPI":false,"project":"5f9c809a8a28490012254347","version":"5f9c809a8a2849001225434e","createdAt":"2020-11-03T13:19:51.849Z","__v":0,"pages":[{"_id":"5faf014675d6da001e083e04","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Attribution Surveys","type":"basic","slug":"attribution","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-13T21:57:26.857Z","category":"5fa158f705478c0012bd39d3","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"654d00d3d2edb90949ef7ef1","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Landing Page (Alpha)","icon":"","type":"basic","slug":"landing-page-alpha","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5fa158f705478c0012bd39d3","createdAt":"2023-11-09T15:54:59.195Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"654d00f76652a31f10c74c21","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Landing Page (HTML)","icon":"","type":"basic","slug":"landing-page-html","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"654d00d3d2edb90949ef7ef1","category":"5fa158f705478c0012bd39d3","createdAt":"2023-11-09T15:55:35.283Z","isBodyEmpty":false,"children":[]},{"_id":"654d01017a569f005ed22f06","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Email Template (HTML)","icon":"","type":"basic","slug":"email-template-html","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"654d00d3d2edb90949ef7ef1","category":"5fa158f705478c0012bd39d3","createdAt":"2023-11-09T15:55:45.730Z","isBodyEmpty":false,"children":[]},{"_id":"654d10f0b14ec7004c53b911","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Klaviyo Flow","icon":"","type":"basic","slug":"klaviyo-flow","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"654d00d3d2edb90949ef7ef1","category":"5fa158f705478c0012bd39d3","createdAt":"2023-11-09T17:03:44.819Z","isBodyEmpty":false,"children":[]}]}]}],"refs":[{"_id":"6220bbe23ea59300135fe5d2","title":"Fairing API","slug":"enquirelabs-api","order":8,"reference":true,"project":"5f9c809a8a28490012254347","version":"5f9c809a8a2849001225434e","createdAt":"2022-03-03T13:00:18.568Z","__v":0,"pages":[{"_id":"622ccbeb335e33008fa1124c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Introduction","type":"basic","slug":"api","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"introduction-2","createdAt":"2022-03-12T16:35:55.207Z","category":"6220bbe23ea59300135fe5d2","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"6220bdc1e6275701a32ceb15","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Authentication","type":"basic","slug":"authentication","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"apiauthentication","createdAt":"2022-03-03T13:08:17.849Z","category":"6220bbe23ea59300135fe5d2","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"622ccc4c4c081f0037ad7d04","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Questions","type":"basic","slug":"questions","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-03-12T16:37:32.815Z","category":"6220bbe23ea59300135fe5d2","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"622ccc5ba8ceb9004545bf55","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"The question object","type":"basic","slug":"question-object","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-03-12T16:37:47.860Z","parentDoc":"622ccc4c4c081f0037ad7d04","category":"6220bbe23ea59300135fe5d2","icon":"","isBodyEmpty":false,"children":[]},{"_id":"622ccd26cc60c9002b8484c8","api":{"method":"get","url":"/questions","auth":"required","results":{"codes":[{"name":"","code":"{\n \"data\": [\n {\n \"allow_other\": true,\n \"customer_type\": \"everyone\",\n \"frequency_type\": \"once\",\n \"id\": 1818,\n \"inserted_at\": \"2021-07-06T14:49:37+00:00\",\n \"other_placeholder\": \"Other\",\n \"prompt\": \"One more thing: How did you hear about us?\",\n \"published_at\": \"2021-09-22T18:57:15+00:00\",\n \"randomize_responses\": false,\n \"responses\": [\n {\n \"clarification_question\": {\n \"allow_other\": true,\n \"id\": 1873,\n \"other_placeholder\": \"Other\",\n \"prompt\": \"Who told you?\",\n \"randomize_responses\": true,\n \"responses\": [\n {\n \"id\": 11834,\n \"value\": \"A friend\"\n },\n {\n \"id\": 11835,\n \"value\": \"A family member\"\n }\n ],\n \"type\": \"single_response\"\n },\n \"id\": 11379,\n \"value\": \"From a friend or family member (has clarification)\"\n },\n {\n \"clarification_question\": null,\n \"id\": 11381,\n \"value\": \"Online Article\"\n },\n {\n \"clarification_question\": {\n \"allow_other\": true,\n \"id\": 2137,\n \"other_placeholder\": null,\n \"prompt\": \"Who is the influencer? \",\n \"randomize_responses\": true,\n \"responses\": [],\n \"type\": \"open_ended\"\n },\n \"id\": 11410,\n \"value\": \"Was it an influencer? \"\n }\n ],\n \"submit_text\": \"Submit\",\n \"type\": \"single_response\",\n \"updated_at\": \"2022-01-07T14:58:01+00:00\"\n },\n {\n \"allow_other\": true,\n \"customer_type\": \"everyone\",\n \"frequency_type\": \"always\",\n \"id\": 33,\n \"inserted_at\": \"2021-05-07T19:14:25+00:00\",\n \"other_placeholder\": null,\n \"prompt\": \"What kind of car do you drive?\",\n \"published_at\": \"2022-02-15T15:39:52+00:00\",\n \"randomize_responses\": true,\n \"responses\": [],\n \"submit_text\": \"Submit\",\n \"type\": \"open_ended\",\n \"updated_at\": \"2022-02-15T15:39:52+00:00\"\n },\n {\n \"allow_other\": true,\n \"customer_type\": \"everyone\",\n \"frequency_type\": \"always\",\n \"id\": 12,\n \"inserted_at\": \"2021-04-20T19:31:04+00:00\",\n \"other_placeholder\": \"Other\",\n \"prompt\": \"Do you own or pay for any of the following?\",\n \"published_at\": \"2022-02-15T15:39:53+00:00\",\n \"randomize_responses\": true,\n \"responses\": [\n {\n \"clarification_question\": null,\n \"id\": 11763,\n \"value\": \"Gym Membership\"\n },\n {\n \"clarification_question\": null,\n \"id\": 11784,\n \"value\": \"Peloton\"\n },\n {\n \"clarification_question\": null,\n \"id\": 11785,\n \"value\": \"Mirror\"\n },\n {\n \"clarification_question\": null,\n \"id\": 11787,\n \"value\": \"Tonal\"\n }\n ],\n \"submit_text\": \"Submit\",\n \"type\": \"multi_response\",\n \"updated_at\": \"2022-02-15T15:39:53+00:00\"\n }\n ]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"apiSetting":"6220bbe23ea59300135fe5d0","examples":{"codes":[{"code":"","language":"curl"}]}},"title":"List all questions","type":"endpoint","slug":"retrieve-questions","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-03-12T16:41:10.343Z","parentDoc":"622ccc4c4c081f0037ad7d04","category":"6220bbe23ea59300135fe5d2","isBodyEmpty":false,"children":[]}]},{"_id":"6220bf448be6c7003d11b594","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Responses","type":"basic","slug":"responses","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-03-03T13:14:44.089Z","category":"6220bbe23ea59300135fe5d2","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"62349c75be46080018e93060","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"The response object","type":"basic","slug":"the-response-object","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"the-response-object-1","createdAt":"2022-03-18T14:51:33.588Z","category":"6220bbe23ea59300135fe5d2","parentDoc":"6220bf448be6c7003d11b594","icon":"","isBodyEmpty":false,"children":[]},{"_id":"6220bf8f7419610131261d4b","api":{"method":"get","url":"/responses","auth":"required","results":{"codes":[{"name":"Success","code":"{\n \"data\":[\n {\n \"available_responses\":null,\n \"clarification_question\":false,\n \"coupon_amount\":null,\n \"coupon_code\":null,\n \"coupon_type\":null,\n \"customer_id\":\"3445695217710\",\n \"customer_order_count\":17,\n \"email\":\"user@example.com\",\n \"id\":\"ENz45Kvbxru0B5X6kDN7Y\",\n \"inserted_at\":\"2022-02-16T17:54:35+00:00\",\n \"landing_page_path\":null,\n \"order_currency_code\":\"USD\",\n \"order_id\":\"4104320450606\",\n \"order_number\":\"1301\",\n \"order_platform\":\"shopify\",\n \"order_source\":\"shopify_checkout\",\n \"order_total\":\"57.71\",\n \"order_total_usd\":\"57.71\",\n \"other\":false,\n \"other_response\":null,\n \"question\":\"Who is your favorite co-founder?\",\n \"question_id\":11,\n \"question_type\":\"single_response\",\n \"referring_question\":null,\n \"referring_question_id\":null,\n \"referring_question_response\":null,\n \"referring_question_response_id\":null,\n \"referring_site\":\"null\",\n \"response\":\"Somebody Else\",\n \"response_id\":11747,\n \"response_position\":1,\n \"response_provided_at\":\"2022-02-16T17:54:34Z\",\n \"submit_delta\":9428,\n \"updated_at\":\"2022-02-16T17:54:35+00:00\",\n \"utm_campaign\":null,\n \"utm_content\":null,\n \"utm_medium\":null,\n \"utm_source\":null,\n \"utm_term\":null\n },\n {\n \"available_responses\":null,\n \"clarification_question\":true,\n \"coupon_amount\":null,\n \"coupon_code\":null,\n \"coupon_type\":null,\n \"customer_id\":\"3446081224750\",\n \"customer_order_count\":10,\n \"email\":\"user_one@example.com\",\n \"id\":\"pk9ZDChjMNueWHZqHEF5Z\",\n \"inserted_at\":\"2021-07-09T18:35:57+00:00\",\n \"landing_page_path\":null,\n \"order_currency_code\":null,\n \"order_id\":\"3821070549038\",\n \"order_number\":\"1260\",\n \"order_platform\":null,\n \"order_source\":null,\n \"order_total\":null,\n \"order_total_usd\":null,\n \"other\":false,\n \"other_response\":null,\n \"question\":\"Which one?\",\n \"question_id\":2138,\n \"question_type\":\"single_response\",\n \"referring_question\":\"How did you hear about us?\",\n \"referring_question_id\":9,\n \"referring_question_response\":\"Online Ad\",\n \"referring_question_response_id\":11733,\n \"referring_site\":null,\n \"response\":\"Facebook\",\n \"response_id\":11734,\n \"response_position\":1,\n \"response_provided_at\":\"2021-07-09T18:35:57Z\",\n \"submit_delta\":1884,\n \"updated_at\":\"2021-07-09T18:35:57+00:00\",\n \"utm_campaign\":null,\n \"utm_content\":null,\n \"utm_medium\":null,\n \"utm_source\":null,\n \"utm_term\":null\n }\n ],\n \"next\":\"https://app.enquirelabs.com/api/responses?after=pk9ZDChjMNueWHZqHEF5Z\",\n \"prev\":\"https://app.enquirelabs.com/api/responses?before=ENz45Kvbxru0B5X6kDN7Y\"\n}","language":"json","status":200},{"name":"","code":"{\n \"message\": \"Not found\",\n \"status\": 404\n}","language":"json","status":404},{"code":"{\n \"message\": \"Unauthorized\",\n \"status\": 401\n}","language":"json","status":401}]},"params":[{"name":"before","type":"string","enumValues":"","default":"","desc":"Response ID, used as a cursor in pagination. Use this to fetch the page **before** the response.","required":false,"in":"query","ref":"","_id":"6220c7d094c85e03d0ac7822"},{"name":"after","type":"string","enumValues":"","default":"","desc":"Response ID, used as a cursor in pagination. Use this to fetch the page **after** the response.","required":false,"in":"query","ref":"","_id":"6220c7d094c85e03d0ac7821"},{"name":"limit","type":"int","enumValues":"","default":"2","desc":"The number of responses to fetch per request. The maximum is 100.","required":false,"in":"query","ref":"","_id":"6220c7d094c85e03d0ac7820"},{"name":"since","type":"timestamp","enumValues":"","default":"","desc":"Use this ISO8601 formatted timestamp to fetch responses that are newer than the supplied value.","required":false,"in":"query","ref":"","_id":"6220c7d094c85e03d0ac781f"},{"name":"until","type":"timestamp","enumValues":"","default":"","desc":"Use this ISO8601 formatted timestamp to fetch responses that are older than the supplied value.","required":false,"in":"query","ref":"","_id":"6220c7d094c85e03d0ac781e"},{"name":"question_id","type":"int","enumValues":"","default":"","desc":"","required":false,"in":"query","ref":"","_id":"62349a13955e4f0196e7ade4"}],"apiSetting":"6220bbe23ea59300135fe5d0","examples":{"codes":[{"code":"","language":"curl"}]}},"title":"List all responses","type":"endpoint","slug":"retrieve-responses","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"list-all-responses","createdAt":"2022-03-03T13:15:59.757Z","parentDoc":"6220bf448be6c7003d11b594","category":"6220bbe23ea59300135fe5d2","isBodyEmpty":false,"children":[]}]}]}]},"baseUrl":"/","apiBaseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"NDU2MjZlM2U2OWJiZGVlZmE4ODkwYjBmZjU0YTVhMTE0ZTM2ZDk1NTIwYWFlNzk3OWZmMjk5NjIxNDUxOThhY3RhZ0ZpbHRlcnM9KHByb2plY3Q6NWY5YzgwOWE4YTI4NDkwMDEyMjU0MzQ3KSwodmVyc2lvbjpub25lLHZlcnNpb246NWY5YzgwOWE4YTI4NDkwMDEyMjU0MzRlKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ==","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false,"graphql":false},"id":"5f9c809a8a28490012254347","name":"Fairing","subdomain":"fairing","subpath":"","nav_names":{"docs":"Documentation","reference":"","changelog":"","discuss":"","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":"fairing"},"version":"1.0"}},"doc":{"metadata":{"image":[],"title":"","description":"","keywords":"","robots":"index"},"mdx":{"altBody":"","status":"rdmd"},"api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"next":{"description":"","pages":[]},"algolia":{"recordCount":1,"publishPending":false,"translationFailure":false},"title":"Introduction","icon":"","updates":[],"type":"basic","slug":"api","excerpt":"An introduction to the Fairing (formerly EnquireLabs) API.","body":"The Fairing API allows you to programmatically fetch your questions and response data. It is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.\n[block:html]\n{\n \"html\": \"If you're a technology partner integrating our API, <span class=\\\"signup__help-action\\\" onclick=\\\"Intercom('showNewMessage')\\\"><a href=\\\"\\\">let us know</a></span> and we'll add you to our documentation.\\n\"\n}\n[/block]","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"reusableContent":[],"previousSlug":"introduction-2","slugUpdatedAt":"2022-03-18T16:09:12.666Z","revision":1,"_id":"622ccbeb335e33008fa1124c","pendingAlgoliaPublish":false,"createdAt":"2022-03-12T16:35:55.207Z","updatedAt":"2022-08-02T15:28:41.560Z","user":"5f9c80860ea4000042041db0","category":{"title":"Fairing API","slug":"enquirelabs-api","order":8,"reference":true,"_id":"6220bbe23ea59300135fe5d2","project":"5f9c809a8a28490012254347","version":"5f9c809a8a2849001225434e","createdAt":"2022-03-03T13:00:18.568Z","__v":0,"type":"reference","id":"6220bbe23ea59300135fe5d2"},"project":"5f9c809a8a28490012254347","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f9c809a8a28490012254350","5f9c809a8a28490012254350","5fa0318c300535004df4438b","5fa031935c0d18004df4d29c","5fa031b47970cc001e62665e","5fa031b7158c71004ae860bd","5fa158f705478c0012bd39d3","5fa3f7f8f62c47004fadc4ef","61424894389be2012719f36f","614249d5c18e5500792e9494","619e689de5d14a03042fb4e5","61a4e7354b35830018f692d7","621fb031cf03a2001aa412a1","6220bbe23ea59300135fe5d2","6220beafe6275701a32ceb5d","622ccc248ec9c6005f750b94","6376bf3a127d9900031710dc"],"pdfStatus":"","_id":"5f9c809a8a2849001225434e","project":"5f9c809a8a28490012254347","releaseDate":"2020-10-30T21:07:38.480Z","createdAt":"2020-10-30T21:07:38.480Z","__v":1},"__v":0,"parentDoc":null,"isApi":false,"tutorials":[],"id":"622ccbeb335e33008fa1124c"},"glossaryTerms":[{"_id":"5fb2dd0ba42ac6004bafcb59","term":"DFC","definition":"Direct-From-Consumer"},{"_id":"5fc7ad3e5a8c65001822b4cd","term":"zero-party data","definition":"Zero party data is data that is given to you by your customers."}],"hideTOC":false,"loginUrl":"https://dash.readme.com/to/fairing","meta":{"_id":"622ccbeb335e33008fa1124c","description":"An introduction to the Fairing (formerly EnquireLabs) API.","hidden":false,"image":[],"keywords":"","metaTitle":"Introduction","parent":null,"robots":"index","slug":"api","title":"Introduction","type":"reference"},"oasDefinition":null,"oasPublicUrl":null,"oauth":false,"rdmd":{"baseUrl":"/","body":"The Fairing API allows you to programmatically fetch your questions and response data. It is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.\n[block:html]\n{\n \"html\": \"If you're a technology partner integrating our API, <span class=\\\"signup__help-action\\\" onclick=\\\"Intercom('showNewMessage')\\\"><a href=\\\"\\\">let us know</a></span> and we'll add you to our documentation.\\n\"\n}\n[/block]","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","baseUrl":"/","terms":[{"_id":"5fb2dd0ba42ac6004bafcb59","term":"DFC","definition":"Direct-From-Consumer"},{"_id":"5fc7ad3e5a8c65001822b4cd","term":"zero-party data","definition":"Zero party data is data that is given to you by your customers."}],"variables":{"user":{},"defaults":[{"source":"security","_id":"62fecaf83550a302c66cb5b2","name":"Authorization","type":"apiKey","apiSetting":"6220bbe23ea59300135fe5d0"},{"source":"security","_id":"62fecb07c35f8a0027ed276f","name":"api_key","type":"apiKey","apiSetting":"621fb031cf03a2001aa4129f"}]}},"terms":[{"_id":"5fb2dd0ba42ac6004bafcb59","term":"DFC","definition":"Direct-From-Consumer"},{"_id":"5fc7ad3e5a8c65001822b4cd","term":"zero-party data","definition":"Zero party data is data that is given to you by your customers."}],"variables":{"user":{},"defaults":[{"source":"security","_id":"62fecaf83550a302c66cb5b2","name":"Authorization","type":"apiKey","apiSetting":"6220bbe23ea59300135fe5d0"},{"source":"security","_id":"62fecb07c35f8a0027ed276f","name":"api_key","type":"apiKey","apiSetting":"621fb031cf03a2001aa4129f"}]},"mdx":false},"slugUrl":"/reference/api","suggestedEdits":true,"variables":{"defaults":[{"source":"security","_id":"62fecaf83550a302c66cb5b2","name":"Authorization","type":"apiKey","apiSetting":"6220bbe23ea59300135fe5d0"},{"source":"security","_id":"62fecb07c35f8a0027ed276f","name":"api_key","type":"apiKey","apiSetting":"621fb031cf03a2001aa4129f"}],"user":{}},"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.235.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":[{"_id":"5fb2dd0ba42ac6004bafcb59","term":"DFC","definition":"Direct-From-Consumer"},{"_id":"5fc7ad3e5a8c65001822b4cd","term":"zero-party data","definition":"Zero party data is data that is given to you by your customers."}],"variables":{"user":{},"defaults":[{"source":"security","_id":"62fecaf83550a302c66cb5b2","name":"Authorization","type":"apiKey","apiSetting":"6220bbe23ea59300135fe5d0"},{"source":"security","_id":"62fecb07c35f8a0027ed276f","name":"api_key","type":"apiKey","apiSetting":"621fb031cf03a2001aa4129f"}]},"project":{"_id":"5f9c809a8a28490012254347","appearance":{"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":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#0265DE","main_alt":"","header_text":"","body_highlight":"","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"solid","img":[],"img_size":"auto","img_pos":"tl"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"referenceLayout":"row","link_logo_to_url":true,"theme":"line","overlay":"triangles","landing":true,"sticky":false,"hide_logo":false,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":false,"logo":["https://files.readme.io/f01dca6-fairing-logo-h-24px.svg","fairing-logo-h-24px.svg",82,24,"#1e233c"],"logo_white":["https://files.readme.io/1a33247-small-Fairing_full_logo_white.png","Fairing full logo white.png",221,80,"#ffffff","https://files.readme.io/9bb7414-Fairing_full_logo_white.png"],"logo_white_use":false,"favicon":["https://files.readme.io/f6dd52b-small-Logo-Turquoise.png","Logo-Turquoise.png",32,32,"#264355","https://files.readme.io/a2813ef-Logo-Turquoise.png"],"stylesheet":"","stylesheet_hub2":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"","html_footer_meta":"","html_hidelinks":false,"showVersion":false,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"search","buttonPrimary":"get-started","buttonSecondary":"docs"},"title":"Fairing Knowledge Center","text":"Welcome to the Fairing Knowledge Center. You'll find comprehensive guides and documentation to help you start working with Fairing as quickly as possible, as well as support if you get stuck. Let's jump right in!","_id":"5f9c809a8a28490012254349"}],"showMetricsInReference":false,"referenceSimpleMode":true,"stylesheet_hub3":"","loginLogo":[],"logo_large":true,"colorScheme":"system","changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false},"custom_domain":"docs.fairing.co","childrenProjects":[],"derivedPlan":"startup2018","description":"Fairing Documentation. Learn how to use Fairing to set up your Question Stream, ask the right survey questions, and integrate with your existing technology and marketing stack.","error404":"","experiments":[],"first_page":"docs","flags":{"allow_hub2":false,"enterprise":false,"alwaysShowDocPublishStatus":false,"hub2":true,"migrationRun":false,"migrationSwaggerRun":false,"oauth":false,"swagger":false,"correctnewlines":false,"rdmdCompatibilityMode":false,"speedyRender":false,"allowXFrame":false,"cookieAuthentication":false,"hideGoogleAnalytics":false,"newEditor":true,"oldMarkdown":false,"newMarkdownBetaProgram":true,"newApiExplorer":true,"disableAnonForum":false,"directGoogleToStableVersion":false,"translation":false,"staging":false,"newSearch":true,"tutorials":true,"allowApiExplorerJsonEditor":false,"useReactApp":true,"auth0Oauth":false,"newHeader":false,"referenceRedesign":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":false,"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,"maskErrorMessages":true},"fullBaseUrl":"https://docs.fairing.co/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"connectedRepository":{"organization":{},"privacy":{}},"installationRequest":{},"github":[]}},"glossaryTerms":[{"_id":"5fb2dd0ba42ac6004bafcb59","term":"DFC","definition":"Direct-From-Consumer"},{"_id":"5fc7ad3e5a8c65001822b4cd","term":"zero-party data","definition":"Zero party data is data that is given to you by your customers."}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"hasOneChild":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":true,"intercom":"uan21vw7","is_active":true,"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"docs","alignment":"left","pageType":"Documentation"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"thumbsEnabled":true,"planLimit":1000000,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false,"graphql":false},"name":"Fairing","nav_names":{"docs":"Documentation","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"api":true,"appearance":false,"domain":false,"jwt":false,"logs":false,"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":"startup2018","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"startup2018","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":true,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":true,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":false,"points":5},"glossary":{"enabled":true,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"percentScore":37.5,"totalScore":165},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"5f9c809a8a2849001225434e","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f9c809a8a28490012254350","5f9c809a8a28490012254350","5fa0318c300535004df4438b","5fa031935c0d18004df4d29c","5fa031b47970cc001e62665e","5fa031b7158c71004ae860bd","5fa158f705478c0012bd39d3","5fa3f7f8f62c47004fadc4ef","61424894389be2012719f36f","614249d5c18e5500792e9494","619e689de5d14a03042fb4e5","61a4e7354b35830018f692d7","621fb031cf03a2001aa412a1","6220bbe23ea59300135fe5d2","6220beafe6275701a32ceb5d","622ccc248ec9c6005f750b94","6376bf3a127d9900031710dc"],"project":"5f9c809a8a28490012254347","releaseDate":"2020-10-30T21:07:38.480Z","createdAt":"2020-10-30T21:07:38.480Z","__v":1},"subdomain":"fairing","subpath":"","superHubWaitlist":true,"topnav":{"left":[{"type":"url","text":"Changelog","url":"https://fairing.canny.io/changelog"},{"type":"url","text":"Status","url":"https://status.fairing.co"}],"right":[{"type":"url","url":"https://docs.fairing.co/page/support","text":"Contact Us"}],"edited":true,"bottom":[]},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2020-11-13T21:07:38.376Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://fairing.co/","versions":[{"_id":"5f9c809a8a2849001225434e","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f9c809a8a28490012254350","5f9c809a8a28490012254350","5fa0318c300535004df4438b","5fa031935c0d18004df4d29c","5fa031b47970cc001e62665e","5fa031b7158c71004ae860bd","5fa158f705478c0012bd39d3","5fa3f7f8f62c47004fadc4ef","61424894389be2012719f36f","614249d5c18e5500792e9494","619e689de5d14a03042fb4e5","61a4e7354b35830018f692d7","621fb031cf03a2001aa412a1","6220bbe23ea59300135fe5d2","6220beafe6275701a32ceb5d","622ccc248ec9c6005f750b94","6376bf3a127d9900031710dc"],"project":"5f9c809a8a28490012254347","releaseDate":"2020-10-30T21:07:38.480Z","createdAt":"2020-10-30T21:07:38.480Z","__v":1}],"variableDefaults":[{"source":"security","_id":"62fecaf83550a302c66cb5b2","name":"Authorization","type":"apiKey","apiSetting":"6220bbe23ea59300135fe5d0"},{"source":"security","_id":"62fecb07c35f8a0027ed276f","name":"api_key","type":"apiKey","apiSetting":"621fb031cf03a2001aa4129f"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","glossary":[{"_id":"5fb2dd0ba42ac6004bafcb59","term":"DFC","definition":"Direct-From-Consumer"},{"_id":"5fc7ad3e5a8c65001822b4cd","term":"zero-party data","definition":"Zero party data is data that is given to you by your customers."}],"canonical_url":null,"description":"Fairing Documentation. Learn how to use Fairing to set up your Question Stream, ask the right survey questions, and integrate with your existing technology and marketing stack.","parent":null,"homepage_url":"https://fairing.co/","id":"5f9c809a8a28490012254347","is_migrated":false,"name":"Fairing","redirects":[],"sitemap":"disabled","subdomain":"fairing","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[{"name":"Authorization","source":"security","type":"apiKey","id":"62fecaf83550a302c66cb5b2"},{"name":"api_key","source":"security","type":"apiKey","id":"62fecb07c35f8a0027ed276f"}],"webhooks":[],"custom_login":{"login_url":null,"logout_url":null},"onboarding_completed":{"api":true,"appearance":false,"documentation":true,"domain":false,"jwt":false,"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":"disabled","response_examples":"collapsed","response_schemas":"collapsed"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"startup2018","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2020-11-13T21:07:38.376Z"}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"integrations":{"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":"uan21vw7","secure_mode":{"key":null,"email_only":true}}},"permissions":{"appearance":{"private_label":"disabled","custom_code":{"css":"disabled","html":"disabled","js":"disabled"}}},"appearance":{"brand":{"primary_color":"#0265DE","link_color":null,"theme":"system"},"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":"large","dark_mode":{"uri":null,"url":"https://files.readme.io/1a33247-small-Fairing_full_logo_white.png","name":"Fairing full logo white.png","width":221,"height":80,"color":"#ffffff","links":{"original_url":"https://files.readme.io/9bb7414-Fairing_full_logo_white.png"}},"main":{"uri":null,"url":"https://files.readme.io/f01dca6-fairing-logo-h-24px.svg","name":"fairing-logo-h-24px.svg","width":82,"height":24,"color":"#1e233c","links":{"original_url":null}},"favicon":{"uri":null,"url":"https://files.readme.io/f6dd52b-small-Logo-Turquoise.png","name":"Logo-Turquoise.png","width":32,"height":32,"color":"#264355","links":{"original_url":"https://files.readme.io/a2813ef-Logo-Turquoise.png"}}},"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":"documentation","left":[{"type":"link_url","title":"Changelog","url":"https://fairing.canny.io/changelog","custom_page":null},{"type":"link_url","title":"Status","url":"https://status.fairing.co","custom_page":null}],"logo_link":"homepage","right":[{"type":"link_url","title":"Contact Us","url":"https://docs.fairing.co/page/support","custom_page":null}],"sub_nav":[],"subheader_layout":"links","version":"disabled","links":{"home":{"label":"Home","visibility":"disabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":"Documentation","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":"5f9c809a8a2849001225434e","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f9c809a8a28490012254350","5f9c809a8a28490012254350","5fa0318c300535004df4438b","5fa031935c0d18004df4d29c","5fa031b47970cc001e62665e","5fa031b7158c71004ae860bd","5fa158f705478c0012bd39d3","5fa3f7f8f62c47004fadc4ef","61424894389be2012719f36f","614249d5c18e5500792e9494","619e689de5d14a03042fb4e5","61a4e7354b35830018f692d7","621fb031cf03a2001aa412a1","6220bbe23ea59300135fe5d2","6220beafe6275701a32ceb5d","622ccc248ec9c6005f750b94","6376bf3a127d9900031710dc"],"project":"5f9c809a8a28490012254347","releaseDate":"2020-10-30T21:07:38.480Z","createdAt":"2020-10-30T21:07:38.480Z","__v":1}},"reqUrl":"/reference/api","version":{"_id":"5f9c809a8a2849001225434e","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f9c809a8a28490012254350","5f9c809a8a28490012254350","5fa0318c300535004df4438b","5fa031935c0d18004df4d29c","5fa031b47970cc001e62665e","5fa031b7158c71004ae860bd","5fa158f705478c0012bd39d3","5fa3f7f8f62c47004fadc4ef","61424894389be2012719f36f","614249d5c18e5500792e9494","619e689de5d14a03042fb4e5","61a4e7354b35830018f692d7","621fb031cf03a2001aa412a1","6220bbe23ea59300135fe5d2","6220beafe6275701a32ceb5d","622ccc248ec9c6005f750b94","6376bf3a127d9900031710dc"],"project":"5f9c809a8a28490012254347","releaseDate":"2020-10-30T21:07:38.480Z","createdAt":"2020-10-30T21:07:38.480Z","__v":1},"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>!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","group","track","ready","alias","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+ "cdn.segment.com" +"/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="3.0.1"; analytics.load("vVXs3ulEHUSURX26E9Czo6oHLB1sqzy1"); }}(); </script><script>!function(t){if(window.ko)return;window.ko=[],["identify","track", "removeListeners", "open", "on", "off", "qualify", "ready"].forEach(function(t){ko[t]=function(){var n=[].slice.call(arguments);return n.unshift(t),ko.push(n),ko}});var n=document.createElement("script");n.async=!0,n.setAttribute("src","https://cdn.getkoala.com/v1/pk_741b7c53479f5b226a1ab43eeebbbd1df161/sdk.js"),(document.body || document.head).appendChild(n)}(); $(window).on('pageLoad', function(e, state){ try { const me = JSON.parse(document.getElementById('hub-me').dataset.json); const email = me.user && me.user.email; if (email) { ko.identify(email); } } catch (e) {} });</script><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,5548,2395,6522,7112,4608,8263,1282,2852,3880,7783,1456,1666,5798,4935,7971,6722,153,1313,1343,4002,3787,6922,2859,6841,1936,9575,1202,8063,2144,2637,4674,1731,6060,1080,9852,8684,5408,2402,678,9141,3221,7327,7285,3307,1948,4467,2616,3412,3859,2578,8899,4793,7031,3556]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","routes-PageNotFound","Footer","core-icons-chevron-up-down-svg","routes-Reference","core-icons-more-vertical-svg","routes-Landing","CustomPage","routes-Doc","core-icons-arrow-right-svg","core-icons-alert-circle-svg","core-icons-arrow-up-right-svg","routes-Changelog","List","core-icons-lock-svg","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","routes-Discuss","Page","core-icons-webhook-svg","Post","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","rmdx","routes-Tutorials","core-icons-trending-up-svg","core-icons-callout-info-svg","routes-CustomPage","core-icons-chevron-down-svg","core-icons-eye-off-svg","New","core-icons-star-svg","core-icons-message-circle-svg","core-icons-key-svg","core-graphics-json-svg"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.766cf20fa350c2c18107.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/5548.8fb1bb5d57de6c263c67.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/4608.3b5a227647e78e858c3f.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/8263.a563779273b90f66c0db.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.a3bb3020bf29f8f67ef8.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.ad57d9fcd570c04fb712.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="Footer" src="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.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-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/6722.e485c5aa155bd0f0ccf8.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="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.f0816876bdfbbc06801a.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-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/routes-Doc.e3a4e0817a9a640436bc.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-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-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="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.3f125a62ed05cc53aec4.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-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.002979730c36f9c65ad3.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-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.6a5b69949f194448cf4f.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-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.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-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.5ccfbee71da134a1eeba.js"></script> <script async data-chunk="rmdx" src="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.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="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-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.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="New" src="https://cdn.readme.io/public/hub/web/New.908bc26e77bebc585452.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="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-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-90823734-3', 'auto', {'name': 'custom'}); $(window).on('pageLoad', function(e, state){ ga('custom.send', 'pageview', window.location.pathname); }); </script><script>$(window).on('pageLoad', function(e, state){ analytics.page(window.location.pathname, state.meta.title, { "context": { "plugin": { "name": "readme_io", "version": "1.0.0" } } }) }); </script><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"NDU2MjZlM2U2OWJiZGVlZmE4ODkwYjBmZjU0YTVhMTE0ZTM2ZDk1NTIwYWFlNzk3OWZmMjk5NjIxNDUxOThhY3RhZ0ZpbHRlcnM9KHByb2plY3Q6NWY5YzgwOWE4YTI4NDkwMDEyMjU0MzQ3KSwodmVyc2lvbjpub25lLHZlcnNpb246NWY5YzgwOWE4YTI4NDkwMDEyMjU0MzRlKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ==","filters":"tagFilters=(project:5f9c809a8a28490012254347),(version:none,version:5f9c809a8a2849001225434e),(hidden:none,hidden:false),(index:CustomPage,index:Page)","metaData":[{"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false,"graphql":false},"id":"5f9c809a8a28490012254347","name":"Fairing","subdomain":"fairing","subpath":"","nav_names":{"docs":"Documentation","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""}}]},"intercom":{"intercom":"uan21vw7","intercom_secure_emailonly":true}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>