REST API

About the QUESTIONSTAR API

The QUESTIONSTAR API (Application Programming Interface) gives you a flexible way to access your survey data and integrate it directly into your own systems and processes. It's especially well suited to advanced scenarios that go beyond the scope of our standard solutions like Power BI or Google Data Studio.

Typical use cases for our REST API:

• You want to add respondents to your survey automatically — for example, from an internal CRM or support system.
• You want to export the answers regularly and process them further, e.g. in your own reporting dashboard.
• You need your own frontend or a specialized tool that works with the survey data in real time.
• You want to analyze results dynamically or have certain KPIs calculated automatically.

The QUESTIONSTAR API is available for applications like these. It's based on the widely used OpenAPI standard (OAS 3.0) and is well documented.

Requirements

To use the QUESTIONSTAR API, you need:

• An active QUESTIONSTAR user account.
• Basic familiarity with REST APIs.
• Optional: a technical contact who can implement API calls in your system.

Generating authorization tokens for the API

To run API calls successfully, you need a valid authorization token. You can create and manage it directly in your QUESTIONSTAR account — here's how:

1. Click your name in the top right

2. and select “Integrations” from the dropdown menu.

   

3. Select “API-Tokens” from the left-hand menu.

4. Click “+ Name your API Key”.

   

5. Give your API key a name, e.g. “CRM integration”.

6. Click “Save”.

   

7. Copy the generated API key and keep it in a safe place.
8. If necessary, you can delete the key later (in which case it becomes invalid) or generate a new one.

Authorization in the API documentation

To run test requests directly in the API documentation (Swagger interface):

1. Open the API documentation: https://api.questionstar.com/
2. Click the “Authorize” button in the top right.
3. Paste in your API key.
4. Confirm with “Authorize”.

Now you can try out all the endpoints and test them right from the interface.

Examples

Example 1: Exporting answers

You want to retrieve all the answers received for a particular questionnaire automatically — e.g. for your own weekly analysis.

Here's how:

1. Call the /ResultCases/GetAnswers endpoint.
2. Pass in the survey ID and, optionally, filter parameters (e.g. time period, status, etc.).
3. The answers are returned in JSON format and can be imported into your system.

Example 2: Adding respondents automatically

Your team uses a CRM system and wants to invite new customers automatically to a personalized welcome survey? Or would you like to gather individual feedback right after a support request?

With the QUESTIONSTAR API, you can automate exactly that — quickly, securely and efficiently.

Here's how:

1. Use the /Respondents/Add endpoint.
2. Pass in the name, the email address and — if you like — additional fields such as customer type or region (via custom fields).
3. Optionally, you can have an invitation email to take part in the survey sent out at the same time.

This saves manual work, reduces sources of error and ensures a professional, automated process — e.g. for onboarding, support requests or internal surveys.

Conclusion

The QUESTIONSTAR API gives you powerful ways to integrate your surveys into your own systems flexibly and efficiently. Especially when standard solutions aren't enough or a higher degree of automation is called for, the API opens up entirely new possibilities.

If you need help getting started, feel free to reach out to our support team.