Loading...
  • Customer Experience
    Customer Experience
  • Employee Experience
    Employee Experience
  • Brand Experience
    Brand Experience
  • Product Experience
    Product Experience
  • Core XM
    Core XM
  • Design XM
    Design XM

API Extension Basic Overview

What's on This Page:


Was this helpful?


This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

The feedback you submit here is used only to help improve this page.

That’s great! Thank you for your feedback!

Thank you for your feedback!


About the API Extension

The Qualtrics API can be used to automate repetitive processes inside of Qualtrics or to pass information in and out of Qualtrics. For example, a Brand Administrator can use the Qualtrics API to 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. Qualtrics also has various API Solution Guides that can help you determine how best to use API for your needs.

Attention: API extensions may require programming knowledge to implement. Our support team does not offer assistance or consultation on custom coding. You can always try asking our community of dedicated users instead. 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 XM Directory (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 documentation for the latest version of the API for each of our products:

Please note that we always recommend that our clients use the latest version of the API.

Understanding the Qualtrics v3 API

The Qualtrics v3 API is a REST API  that 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, POST, PUT, or DELETE requests, which return 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://yourdatacenterid.qualtrics.com/API/

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.

Qtip: We recommend allowlisting yourdatacenterid.qualtrics.com if you are using our API from behind a firewall.

You can find your datacenter ID by logging into your account and looking at the URL in the browser address bar. The part before qualtrics.com is your datacenter ID. Alternatively, if you are not using the correct datacenter ID, you will get a notice in the HTTP response when you run an API request, indicating the datacenter ID you should be using instead. In the below example, the datacenter is au1.

Data center specification in API call request

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.

You will always need to pass the API token through the header of the request as X-API-TOKEN. Depending on the specific request being run, you may need to pass other parameters through the header, through the URL, or through the body of the request. When passing parameters through the body, you need to send the parameters as JSON. When using this method, you must specify a Content-Type (i.e., application/json or multipart/form-data).

Example: In the following POST example, in cURL we specify the Base URL, the Content-Type, and the Token in the header. The Survey ID and format of export are specified in the body.

curl -X POST -H 'X-API-TOKEN: yourapitokenhere' -H 'Content-Type: application/json' -d '{

    "surveyId": "SV_012345678912345",

    "format": "csv"

}' 'https://yourdatacenterid.qualtrics.com/API/v3/responseexports'

Generating an API Token

An API token will be required to access the Qualtrics API. Each user in a license must generate their own API token. Your account’s API token is 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. To authenticate, include your token under the HTTPS header X-API-TOKEN.

Qtip: To generate a token, the user must have the Access 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.
    Silhouette button in top-right corner or Qualtrics page
  2. Select Account Settings.
    Account Settings in Silhouette dropdown
  3. Click Qualtrics IDs on the navigation bar.
    Qualtrics IDs in Account Settings
  4. In the box labeled API, click Generate Token.
    Generate Token button in Qualtrics IDs
Warning: Do not click Generate Token if you already have a token. Your API token only needs to be generated once. If you generate a new token and you have existing extensions that use the old token, those existing extensions will be interrupted. Generating a new token is irreversible; it is not possible to retrieve previous tokens.

API OAuth

Attention: You are reading about a feature only Brand Administrators have access to.

OAuth 2.0 is a framework proposed by the IETF in 2012. When you perform API calls, you generate a token. Sometimes you want to work with third party users, but you don’t want to give your login information or this token out to them, since they can use this token later to access your API. You also don’t want to keep generating a new token, since this would invalidate other API calls you have set up.

Instead, you can use API OAuth to temporarily generate something known as the Client Secret. This Client Secret will be “refreshed” after an hour, meaning it’ll stop working. For more information about API OAuth and how to use it in API calls, check out our official API documentation.

Creating a Client Secret

  1. Click the silhouette icon in the top right hand corner of your Qualtrics account.
    Manage Oauth clients and create a client

  2. Select Account Settings.
  3. Navigate to Qualtrics IDs.
  4. Choose OAuth Client Manager.
  5. Click Create Client.
  6. Enter a client name.
    Create a new Oauth client

  7. If desired, enter a contact email address.
  8. For Grant Type, choose Client Credentials.
  9. Click Create Client.
  10. Write down the Client ID and Client Secret and store them in a secure location.
    Client credentials, client ID, client secret

    Attention: Once you exit out of this window, the Client Secret is irretrievable. If you lose or forget your Client Secret, you will need to repeat the above process to generate a new one.

Mobile App SDK

In order to get your Mobile App Feedback Project up and running, there’s an extension you must implement on your end. The Mobile App SDK (Software Developer’s Kit) can be found at the following pages: