x

REST API

Home > Coder’s Corner > REST API
Survey Research Suite

Guide

Set up an outside program to interface directly with Qualtrics.

To use the REST API

API access is not available for all accounts – check with your administrator to see if it is available for you.

The API will require the use of IDs from your account. To access these IDs,

  1. Click on your name at the top right of Qualtrics.
  2. Select Account Settings.
  3. Click Qualtrics IDs on the gray navigation bar.
  4. Click on any library to see IDs for panels, messages, and other library content. Click on any survey title to see IDs for questions, quotas, and other survey elements.
Qualtrics REST API Calls
Here is the online documentation for our latest API Calls. You can also click here to download a PDF of our older REST API calls. These calls still work.


Example API Calls

Add Members to a Panel

https://new.qualtrics.com/Server/RestApi.php?Request=importPanel&User=userName&Password=password&Libra
ryID=UR_1234567&ColumnHeaders=1&Email=3&FirstName=1&LastName=2&URL=http%3a%2f%2fwww.q.com%2f
file.csv

Download the Responses For A Survey
https://new.qualtrics.com/Server/RestApi.php?Request=getResponseData&User=userName&Password=password
&SurveyID=SV_123456789&Format=CSV
Send a Survey to a Panel
https://new.qualtrics.com/Server/RestApi.php?Request=sendSurveyToPanel&User=userName&Password=Passwor
d&SurveyID=SV_12345&SendDate=2008-02-15 
13:00:00&FromEmail=test@qualtrics.com&FromName=Name&Subject=Test&MessageID=MS_12345&MessageLibr
aryID=UR_12345&PanelID=ML_12345&PanelLibraryID=UR_12345