Qualtrics

Qualtrics API

Work with Qualtrics surveys, distributions and response events

Other#openapi#forms

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Work with Qualtrics surveys, distributions and response events

Endpoints 8

  • POSTCreate contact in mailing list/directories/:DirectoryId/mailinglists/:MailingListId/contactsCreates a contact in a given mailing list
  • GETGet distributions for survey/distributions?surveyId=stringGets all distributions for a given survey
  • POSTGenerate distribution links/distributionsGeneates links for individual distribution
  • GETRetrieve distribution links/distributions/:DistributionId/links?surveyId=stringRetrieves all the individual links for a given distribution
  • POSTTriggers when a response is submitted to a qualtrics survey/eventsubscriptions/Subscribe to response event
  • DELETERemove subscription to response event/eventsubscriptions/Remove event subscription
  • GETGet event subscriptions/eventsubscriptions/:SubscriptionIdGet event subscriptions
  • GETGet survey/survey-definitions/:SurveyIdGets a single Qualtrics survey speficied by its ID

API details

Base URL
https://fra1.qualtrics.com/API/v3
Authentication
An API key in the X-API-TOKEN header
Operations
8 operations on 6 pathsGET 4POST 3DELETE 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 0.2
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Qualtrics API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Qualtrics API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-API-TOKEN header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create contact in mailing list” (POST /directories/:DirectoryId/mailinglists/:MailingListId/contacts), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Qualtrics API?

Work with Qualtrics surveys, distributions and response events It is listed under Other and has 8 endpoints.

Who publishes the Qualtrics API?

It is listed from Qualtrics's public API description (an OpenAPI document), not published by Qualtrics on Swastik Codes. Anyone who controls qualtrics.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Qualtrics API?

Requests go to https://fra1.qualtrics.com/API/v3. Endpoint paths are added to this base URL.

How do I authenticate with the Qualtrics API?

With an API key in the X-API-TOKEN header.

How many endpoints does the Qualtrics API have?

8 operations on 6 paths (4 GET, 3 POST, 1 DELETE).

Is forking the Qualtrics API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.