{"article":{"id":58239664639513,"url":"https://reflektive.zendesk.com/api/v2/help_center/en-us/articles/58239664639513.json","html_url":"https://support.reflektive.com/hc/en-us/articles/58239664639513-Technical-API-Documentation","author_id":902673952143,"comments_disabled":false,"draft":false,"promoted":false,"position":2,"vote_sum":0,"vote_count":0,"upvote_count":0,"downvote_count":0,"section_id":58239552232345,"created_at":"2026-05-24T13:31:58Z","updated_at":"2026-05-24T13:31:58Z","name":"Technical API Documentation","title":"Technical API Documentation","source_locale":"en-us","locale":"en-us","outdated":false,"outdated_locales":[],"edited_at":"2026-05-24T13:31:58Z","user_segment_id":null,"permission_group_id":317186,"content_tag_ids":[],"label_names":[],"body":"<div class=\"screensteps-document\" data-controller=\"article\" id=\"screensteps-webpost-1714253\" data-ss-edit-in-web-url=\"https://bridgeapp.screenstepslive.com/admin/v2/article-editor/1714253\" data-ss-view-in-admin-url=\"https://bridgeapp.screenstepslive.com/admin/v2/sites/24820/all-articles?showArticle=1714253\" data-ss-edit-in-desktop-url=\"screensteps://bridgeapp.screenstepslive.com/open/s/24820/m/118989/a/1714253\" data-role=\"steps-container\" data-ss-article-type=\"article\">\n<template id=\"article_translations\" data-translation-clipboard-copy=\"Click to copy\" data-translation-clipboard-copied=\"Copied to clipboard!\">\n</template>\n\n\n    <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_3B727E73-02F3-4B6E-B9C4-5AE54D6FDD86\" class=\"text-block-content\">\n    <p>Reflektive offers API functionality, which continues to expand both in scope and functionality, to any interested customers. For those customers who wish to leverage it and manipulate data from the Reflektive platform, please look below for additional information.</p>\n  </div>\n</div>\n\n    <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_D9BA1175-1D23-4EB4-A87D-25E41D643DC5\" class=\"text-block-content\">\n    <p><span style=\"font-weight:400;\">Swaggerhub hosts Reflektive’s API information online and allows users to interact with various endpoints to execute sample calls.<br><br></span></p>\n  </div>\n</div>\n\n      <div class=\"image screensteps-image\">\n      <a href=\"https://media.screensteps.com/image_assets/assets/007/728/958/original/SwaggerHub_Logo_Horizontal_Color.png\" class=\"screensteps-image-zoom\">\n        <img src=\"https://support.reflektive.com/hc/article_attachments/58239604409369\" srcset=\"\" alt=\"\" height=\"217\" width=\"855\">\n      </a>\n  </div>\n\n    <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_B209491E-1ED8-4D16-B565-6B86C291D35E\" class=\"text-block-content\">\n    <p><em><span style=\"font-weight:400;\">**Note that customers should use API software (e.g. </span></em><a href=\"https://www.getpostman.com/\"><em><span style=\"font-weight:400;\">Postman</span></em></a><em><span style=\"font-weight:400;\">) or the Command Line/Terminal to retrieve full data sets and NOT Swaggerhub.**</span></em></p>\n  </div>\n</div>\n\n      <div class=\"step screensteps-section screensteps-depth-1\" id=\"authorizing-swaggerhub-for-sample-calls\" data-step-uuid=\"2CFF97E4-C1EF-46B3-AF69-65D163ED95F6\">\n    <h2 id=\"authorizing-swaggerhub-for-sample-calls\" class=\"step-title screensteps-heading\">Authorizing Swaggerhub for Sample Calls</h2>\n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_209A6C87-B78A-42E7-8C39-30D9158E26B9\" class=\"text-block-content\">\n    <p><span style=\"font-weight:400;\">To authorize into Swaggerhub for testing, please follow the steps below:</span></p>\n  </div>\n</div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_91F6213D-448F-4999-B251-174C2D807D62\" class=\"text-block-content\">\n    <ol>\n<li style=\"font-weight:400;\"><span style=\"font-weight:400;\">Obtain an <strong>API token</strong> and <strong>company UUID</strong> from Reflektive via your Engagement Manager or Customer Success Manager.</span></li>\n<li style=\"font-weight:400;\">\n<span style=\"font-weight:400;\">Visit </span><span style=\"font-weight:400;\"><a href=\"https://app.swaggerhub.com/apis-docs/Reflektive/API/1\">https://app.swaggerhub.com/apis-docs/Reflektive/API/1</a></span>\n</li>\n<li style=\"font-weight:400;\"><span style=\"font-weight:400;\">On the right hand side of the screen, click the “Authorize” button<br></span></li>\n<li style=\"font-weight:400;\"><span style=\"font-weight:400;\">Paste your API token in the field provided, making sure that there are no spaces at the beginning/end of the string<br></span></li>\n</ol>\n  </div>\n</div>\n \n        <div class=\"image screensteps-image\">\n      <a href=\"https://media.screensteps.com/image_assets/assets/007/728/961/original/image4.png\" class=\"screensteps-image-zoom\">\n        <img src=\"https://support.reflektive.com/hc/article_attachments/58239689615001\" srcset=\"\" alt=\"\" height=\"351\" width=\"855\">\n      </a>\n  </div>\n \n        <div class=\"image screensteps-image\">\n      <a href=\"https://media.screensteps.com/image_assets/assets/007/728/965/original/image5.png\" class=\"screensteps-image-zoom\">\n        <img src=\"https://support.reflektive.com/hc/article_attachments/58239657870745\" srcset=\"\" alt=\"\" height=\"418\" width=\"855\">\n      </a>\n  </div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_68E44777-ABD5-40E9-BF4D-06C5BCA548CD\" class=\"text-block-content\">\n    <p><span style=\"font-weight:400;\">Available endpoints are listed on the page and clicking into each one shows details about the call parameters, including acceptable &amp; default values, and a sample call response with fields and data type identified.</span></p>\n  </div>\n</div>\n \n  </div>\n\n      <div class=\"step screensteps-section screensteps-depth-1\" id=\"executing-a-sample-call\" data-step-uuid=\"42097E8B-3292-45B2-9E0B-3651C4105E57\">\n    <h2 id=\"executing-a-sample-call\" class=\"step-title screensteps-heading\">Executing a Sample Call</h2>\n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_055CE3D9-34C8-45E6-A4F2-E54E7D43C6A4\" class=\"text-block-content\">\n    <p><span style=\"font-weight:400;\">If you click into an endpoint, you can then click the “Try It Out” button to execute a sample call. You will need to provide a value for each of the parameters listed in the expanded endpoint. </span></p>\n  </div>\n</div>\n \n        <div class=\"image screensteps-image\">\n      <a href=\"https://media.screensteps.com/image_assets/assets/007/728/969/original/image1.png\" class=\"screensteps-image-zoom\">\n        <img src=\"https://support.reflektive.com/hc/article_attachments/58239689703705\" srcset=\"\" alt=\"\" height=\"380\" width=\"855\">\n      </a>\n  </div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_1CC5B818-24C2-4E78-9398-CB81B0665272\" class=\"text-block-content\">\n    <p><span style=\"font-weight:400;\">Once everything is complete, clicking “Execute” will run the command.  If successful, the screen will display the cURL command, the Request URL, the Response Body, and the Response Headers. You can download the Response Body to view the data in a .JSON file. </span></p>\n  </div>\n</div>\n \n        <div class=\"image screensteps-image\">\n      <a href=\"https://media.screensteps.com/image_assets/assets/007/728/972/original/image6.png\" class=\"screensteps-image-zoom\">\n        <img src=\"https://support.reflektive.com/hc/article_attachments/58239657921049\" srcset=\"\" alt=\"\" height=\"400\" width=\"855\">\n      </a>\n  </div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_AF9C9E9F-C486-4FC5-93C0-69F783F8718E\" class=\"text-block-content\">\n    <p><em><span style=\"font-weight:400;\">Sample cURL, URL, and Response for Cycles within a Company</span></em></p>\n  </div>\n</div>\n \n        <div class=\"image screensteps-image\">\n      <a href=\"https://media.screensteps.com/image_assets/assets/007/728/974/original/image2.png\" class=\"screensteps-image-zoom\">\n        <img src=\"https://support.reflektive.com/hc/article_attachments/58239657945881\" srcset=\"\" alt=\"\" height=\"489\" width=\"855\">\n      </a>\n  </div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_92C24572-DF6A-41FB-8A97-E911B0B38060\" class=\"text-block-content\">\n    <p><em><span style=\"font-weight:400;\">**Note that depending on the size of the data set Swaggerhub may not return an exhaustive list of data. To generate a full data set, please execute commands via API software or the Command Line/Terminal.**</span></em></p>\n  </div>\n</div>\n \n  </div>\n\n      <div class=\"step screensteps-section screensteps-depth-1\" id=\"frequently-asked-questions\" data-step-uuid=\"CC8666A7-F5F5-42C4-98AD-2DE4E743EC77\">\n    <h2 id=\"frequently-asked-questions\" class=\"step-title screensteps-heading\">Frequently Asked Questions</h2>\n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_73C47C86-AD0B-450F-9486-B7DAF249A2DD\" class=\"text-block-content\">\n    <p><strong>Q: Does Reflektive’s API have read/write access?</strong></p>\n  </div>\n</div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_22AE24D7-0063-45D5-BF07-8801B48F4A25\" class=\"text-block-content\">\n    <p><span style=\"font-weight:400;\">A: The API allows for read access across the Reflektive platform and write access across Reviews, Employees, and Real-Time Feedback.</span></p>\n  </div>\n</div>\n \n      <div class=\"screensteps-table\">\n  <table style=\"width:100%;\"><tbody>\n<tr>\n<td>\n<p><strong>Product Area</strong></p>\n</td>\n<td>\n<p><strong>Read Access</strong></p>\n</td>\n<td>\n<p><strong>Write Access</strong></p>\n</td>\n</tr>\n<tr>\n<td>\n<p><span style=\"font-weight:400;\">Reviews</span></p>\n</td>\n<td>\n<p><span style=\"font-weight:400;\">YES</span></p>\n</td>\n<td>\n<p><span style=\"font-weight:400;\">Only via PATCH call (typically used for calibration)</span></p>\n</td>\n</tr>\n<tr>\n<td>\n<p><span style=\"font-weight:400;\">Employees</span></p>\n</td>\n<td>\n<p><span style=\"font-weight:400;\">YES</span></p>\n</td>\n<td>\n<p><span style=\"font-weight:400;\">YES</span></p>\n</td>\n</tr>\n<tr>\n<td>\n<p><span style=\"font-weight:400;\">Goals</span></p>\n</td>\n<td>\n<p><span style=\"font-weight:400;\">YES</span></p>\n</td>\n<td>\n<p><span style=\"font-weight:400;\">YES</span></p>\n</td>\n</tr>\n<tr>\n<td>\n<p><span style=\"font-weight:400;\">Reports</span></p>\n</td>\n<td>\n<p><span style=\"font-weight:400;\">YES (only goals report available)</span></p>\n</td>\n<td>\n<p><span style=\"font-weight:400;\">NO</span></p>\n</td>\n</tr>\n<tr>\n<td>\n<p><span style=\"font-weight:400;\">Real-Time Feedback</span></p>\n</td>\n<td>\n<p><span style=\"font-weight:400;\">YES</span></p>\n</td>\n<td>\n<p><span style=\"font-weight:400;\">YES</span></p>\n</td>\n</tr>\n</tbody></table>\n\n</div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_9D501CEA-10DF-416F-B239-004DB385EA37\" class=\"text-block-content\">\n    <p><strong>Q: Does Reflektive offer a data dictionary?</strong></p>\n  </div>\n</div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_7CA9E1D9-549D-490C-B4CD-0DA76ECC435A\" class=\"text-block-content\">\n    <p><span style=\"font-weight:400;\">A: At the bottom of the Swaggerhub page, there is an expandable set of data models that shows exactly what fields are returned across the API and what values are within them. You can expand the models by clicking the &gt; icon wherever it appears.</span></p>\n  </div>\n</div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_FF772F54-F3FD-460A-8652-24FC4E9B2149\" class=\"text-block-content\">\n    <p><strong>Q: The Reviews endpoint only allows me to obtain the answers for a single question within a cycle -- how do I pull all of the responses to all questions?</strong></p>\n  </div>\n</div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_CE8C41E1-6528-4B12-9847-0F3DAE93B71B\" class=\"text-block-content\">\n    <p><span style=\"font-weight:400;\">A: In order to pull a full data set of responses for all questions in a review cycle you’ll need to write a script that iterates through all of the questions ids within the cycle.</span></p>\n  </div>\n</div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_A8744AA1-1213-4F73-8767-8019A0DD63DE\" class=\"text-block-content\">\n    <p><strong>Q: Does Reflektive offer a sandbox environment to test API calls on?</strong></p>\n  </div>\n</div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_F46B1124-6726-4925-BC01-5C7AF1536B96\" class=\"text-block-content\">\n    <p><span style=\"font-weight:400;\">A: If needed, Reflektive can create a sandbox environment for API testing. The API Token and Company UUID will differ from the “Production” credentials and the sandbox will not have any data in it.</span></p>\n  </div>\n</div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_54A9C177-5941-4717-BF02-35901A48CC85\" class=\"text-block-content\">\n    <p><strong>Q: Can I schedule time with a Reflektive engineer to review code I wrote and/or get sample code from them?</strong></p>\n  </div>\n</div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_715C42B0-93F2-4E4E-BF64-616215B052A4\" class=\"text-block-content\">\n    <p><span style=\"font-weight:400;\">A: Reflektive does not offer API Developer support. Our assumption is that organizations looking to leverage our API have experienced engineers on their end that can successfully code API calls that meet the business need.</span></p>\n  </div>\n</div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_02B1A04C-12AD-465E-8BC8-90024B94F036\" class=\"text-block-content\">\n    <p><strong>Q: My organization needs access to our data ASAP but the API development will take too long -- what should we do?</strong></p>\n  </div>\n</div>\n \n      <div class=\"step-instructions screensteps-textblock\">\n  <div id=\"text-content_132A2B82-A650-43D2-BE8B-EED8DF2F9174\" class=\"text-block-content\">\n    <p><span style=\"font-weight:400;\">A: All data available via the Reflektive API is also available via our CSV reports. If, for example, you need all review data ported to a different system for analytics or record keeping, a Reflektive reviews admin can request the “All Review Feedback” report for all cycles. Once generated, the CSVs can be manipulated/uploaded to fit the business need. </span></p>\n  </div>\n</div>\n \n  </div>\n\n\n\n</div>"}}