Survey Platform - API Documentation | Qualtrics

Using Qualtrics API Documentation

Introduction

Our Qualtrics API Documentation page details all of our current available documentation. This page walks through how to navigate our documentation, outlining what each section discusses and what’s available.

API Versions

The most current version of the Qualtrics API is version 2.5. Updating an integration can be time consuming though, so we are backward compatible with all versions of our API (previous documentation can be accessed by clicking on the version you want in the Versions area). However, we recommend our clients use the most current version of the API.

image04

Overview

In the API Overview, you can see information about the Qualtrics API in general. Topics of discussion include the root URL, methods of passing parameters, required parameters, parameters specific to JSON and JSONP, the returned response, HTTP error codes, an example request, and redirects. Of these topics, the most common are discussed on our support pages.

Authentication

The Authentication section outlines what information is needed to authenticate your requests. For more information on the authentication process, view Generating an API Token.

Requests

Under the Requests section, you’ll find a list of all available API requests. To help organize the documentation and help users find the API requests they’re looking for, these requests are categorized into six different types:

  • Administration Requests
  • Library Requests
  • Panel Requests
  • Reporting Requests
  • Responses Requests
  • Survey Requests

image02

Request Parameters and Options

Each API request has a name, a brief description, a table that lists possible parameters, the response, an example request, and the “Try It!” wizard. Understanding how to use this information can help streamline your work.

image03

Name and description

The first two things that are listed for any API request is the name and a brief description of the request.

image00

List of parameters

For each API request, you’ll see a table listing all possible parameters that can be used (some will be optional, some will be required). This table has four columns:

Name
Each parameter’s name.
Value(s)/Formatting
The accepted formats for each parameter.
Required Default
Whether or not the parameter is required for the request to run.
Description
A brief description of the parameter.
Attention: All parameter names and values are case sensitive.

image05

Response

Response gives a brief description of what you can expect to receive once your API request was successful. For example, if you’re using the API request createUser, your response will be the user ID of the newly created user.

image01

Example

The example given shows a completed API request using standard query string syntax (note that since the IDs are only examples and not real IDs, the request won’t actually work). Notice that this API request includes the root URL and all possible parameters from the parameters table.

image07

Try it!

The Try it! function is a wizard that allows you to quickly and easily construct an API request (note that most API requests require Qualtrics IDs). Let’s discuss the wizard by using our example API request createUser.

image09

The wizard is broken into three sections: global parameters, required parameters, and additional parameters.

Global Parameters
Parameters that the Try it! wizard will pre-populate for you.
Required Parameters
Parameters that must be given values or the request will not run successfully (these are unique to each request).
Additional Parameters
Parameters that are optional.
Qtip: To know what values are acceptable for each parameter, refer to the table of parameters for the request.

image08

Once you’ve entered the needed values for your request, click Run Request. The URL returned to you in the URL box is the standard query string syntax form of your API request.

image06