Technical API Documentation

To authorize into Swaggerhub for testing, please follow the steps below:

1. Obtain an API token and company UUID from Reflektive via your Engagement Manager or Customer Success Manager.
2. Visit https://app.swaggerhub.com/apis-docs/Reflektive/API/1
3. On the right hand side of the screen, click the “Authorize” button
   
4. Paste your API token in the field provided, making sure that there are no spaces at the beginning/end of the string
   

Available endpoints are listed on the page and clicking into each one shows details about the call parameters, including acceptable & default values, and a sample call response with fields and data type identified.

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.

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.

Sample cURL, URL, and Response for Cycles within a Company

**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.**

Q: Does Reflektive’s API have read/write access?

A: The API allows for read access across the Reflektive platform and write access across Reviews, Employees, and Real-Time Feedback.

Q: Does Reflektive offer a data dictionary?

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 > icon wherever it appears.

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?

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.

Q: Does Reflektive offer a sandbox environment to test API calls on?

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.

Q: Can I schedule time with a Reflektive engineer to review code I wrote and/or get sample code from them?

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.

Q: My organization needs access to our data ASAP but the API development will take too long -- what should we do?

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.