Insight Platform - API | Qualtrics

API Integration Overview

Introduction

The Qualtrics API can be used to automate repetitive processes inside of Qualtrics or to pass information in and out of Qualtrics. With API, a Brand Administrator can automate the account creation process rather than create hundreds of accounts individually. Similarly, a user can automate contact list creation rather than manually compile and import contact lists.

Attention: API integrations may require programming knowledge to implement. Our support team does not offer assistance or consultation on custom coding. If you’d like to know more about our custom coding services, please contact your Qualtrics Account Executive.

API Access for Different Products

Qualtrics has a variety of different products that allow you to gather actionable data in real time. Some of these products include the Survey Platform, Site Intercept, and Target Audience. Once you’ve purchased the Qualtrics API feature, you’ll be able to use the API for any products that are a part of your license.

Here are links to the API documentation for each of our products:

Understanding the Qualtrics REST API

The Qualtrics REST API allows you to communicate or query our system using a simple URL syntax. Communicating with the Qualtrics system can be thought of as a sequence of requests. You can request information to be sent to Qualtrics, updated, removed, or returned to your system. These requests can be made by either GET or POST requests, which most often return XML or JSON responses.

Through these means, the Qualtrics API allows you to interact with parts of the Qualtrics system and integrate these areas with your CRM.

Getting Started

The current Qualtrics API system uses a root URL to perform requests:

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php

The root URL is the foundation for any API request. Notice that the protocol is https and thus is encrypted to ensure the protection of your credentials.

Possible methods for passing parameters

Parameters are the building blocks for your requests. Each API request requires several global parameters to be passed to Qualtrics, as well as more request-specific parameters and a few optional ones. To pass these parameters in your API request, you have two possible methods. Note that you can use both methods in the same request.

The first method involves standard query string syntax. You append the needed parameters to the root URL, and those parameters are passed through the query string.

Example: In the following URL, the parameters Request, User, Token, Format, and SurveyID have been appended to the end of the root URL.

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?Request=getLegacyResponseData&User=apiuser&Token=lksjdfJdJklajdf3asdae3&Format=XML&SurveyID=SV_123456789

The second method requires passing the parameters as JSON through the body of the request. When using this method, you must specify a Content-Type (i.e., application/json or text/json).

Example: In the following POST we specify the Request URI, the Content-Type, and then pass User, Token, and Survey ID into the body.

Request URI: https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?Request=getLegacyResponseData&Format=XML
Content-Type: application/json
Request Body: {"User":"apiuser","Token":"lksjdfJdJklajdf3asdae3","SurveyID":"SV_123456789"}

Required parameters

All Qualtrics API requests must begin with the root URL and several required parameters. These parameters are detailed in the list below. In addition, most requests have other necessary parameters, but these depend on the specific request being made and are not discussed below.

Parameter Name
Parameter Description
Request
The API request being made. Each has a case-sensitive unique name, as well as a specific set of parameters.
User
The Qualtrics username that will be requesting the API call. The user must have permission to use Qualtrics APl.
Token
An alphanumeric value used to verify that the specified username is owned by the requester.
Format
The format of the response that will be returned. Defaults are XML, JSON, or JSONP. Some API requests will have other options for response formats.
Version
The version of the API being used.
Attention: Parameter names and parameter values are case sensitive. API requests will return a status of failure if your request is not properly formatted.

Generating an API Token

An API token will be required to access the Qualtrics API. Both your account’s API token and your account’s username are required to authenticate each API request you create. Your token is used in place of your account’s password and helps enhance the security of your work.

Qtip: To generate a token, the user must have the API permission enabled for their account. If your organization doesn’t have access to the Qualtrics API feature, please contact your Qualtrics Account Executive for more information.

To generate an API token

  1. Click on the silhouette in the top right corner of your account.
    image00
  2. Select Account Settings.
    image02
  3. Click Qualtrics Ids on the navigator bar.
    image01
  4. In the box labeled API, click Generate Token.
    image03
Warning: Do not click Generate Token if you already have a token. Your API token only needs to be generated one time. If you generate a new token and you have existing integrations that use the old token, those existing integrations will be interrupted.