Qualtrics API API

by qualtrics.com

Overview

Work with Qualtrics surveys, distributions and response events

Qualtrics API is a documents & productivity API from qualtrics.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 8 endpoints.

At a glance

Authentication: API key
HTTPS: Yes
CORS: Unknown
Category: Documents & Productivity
Base URL: https://fra1.qualtrics.com/API/v3
Version: 0.2
Endpoints: 8
OpenAPI: Specification ↗
Spec updated: 2021-06-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://fra1.qualtrics.com/API/v3/distributions" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const response = await fetch("https://fra1.qualtrics.com/API/v3/distributions", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://fra1.qualtrics.com/API/v3/distributions",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
POST	`/directories/{DirectoryId}/mailinglists/{MailingListId}/contacts`	Create contact in mailing list
GET	`/distributions`	Get distributions for survey
POST	`/distributions`	Generate distribution links
GET	`/distributions/{DistributionId}/links`	Retrieve distribution links
POST	`/eventsubscriptions/`	Triggers when a response is submitted to a qualtrics survey
DELETE	`/eventsubscriptions/`	Remove subscription to response event
GET	`/eventsubscriptions/{SubscriptionId}`	Get event subscriptions
GET	`/survey-definitions/{SurveyId}`	Get survey