API V2

Upcoming changes for API Key Authentication

As part of our ongoing commitment to providing a more secure and streamlined experience, we will be making some changes to how API keys are used for authentication. Please go through this document to understand the upcoming changes to the API key authentication.


What's Changing?

Our API currently offers two ways to authenticate using API keys: as a query parameter and in the header. Starting March 31, 2024, we will discontinue support for passing API keys as query parameters. You must use API keys exclusively in the header for authentication.


New API Key Format

We are also changing the format of the API key in the header. Refer to the following table for the changes in the API key format:

Existing format "apiKey" : "Your QuestionPro account API key"
New format "api-key" : "Your QuestionPro Account API key"

Action Required

To ensure uninterrupted access to our API services, please make the necessary adjustments to your code by March 31, 2024. Update your authentication method to use the new API key format in the header as shown above. Here's an example of how your API requests should be structured after the changes:

API URL https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}
Header
application/json 

{
    "api-key" : "Your_QuestionPro_Account_API_key"
}

Please make sure to update your code accordingly before the specified date to avoid any disruptions in service. If you have any questions or need assistance with this transition, feel free to reach out to our support team.