Skip to main content

Other APIs

Here are a few additional APIs which have various levels of support. Please contact support before considering using any of these APIs to understand the level of support or limitations of these APIs

1. Not supported please do not call.​

https://reporting.qualtrics.com/API/v2/docs/Distributions.html#distributions-api https://ca1.qualtrics.com/phoneservice/v1/docs

2. Supported for some scenarios​

https://s.qualtrics.com/automations-file-service/docs/

3. Limited Support​

These APIs will not be supported long term. Please contact your Customer Success Manager before considering using.

Get User MetaData

/users/{userId}/metadata GET

Update User MetaData

/users/{userId}/metadata POST

User Metadata​

This API has two paths to call. The paths and the examples for those paths are laid out below.

This API is not released for Public consumption​

This API is private and you need approval from Qualtrics Engineering Team to call this API.

CX/EX Users Only​

Only users associated with a CX/EX licensed Qualtrics brand may contain associated metadata.

Administrator Request​

To use this call you must be a Qualtrics brand administrator.

Get User Metadata​

To get user metadata, make a call like this curl example:

curl -H 'X-API-TOKEN: yourtokenhere' 'https://yourdatacenterid.qualtrics.com/API/v3/users/{userID}/metadata'

The {userId} variable above is the ID of the user you want metadata from. This should be available in your account settings page.

The results you should expect will depend on your user's metadata, but will look something like this:

{
  "result": {
    "fieldA": "metadataValueA",
    "fieldB": "metadataValueB",
    "fieldC": "metadataValueC",
  },
  "meta": {
    "httpStatus": "200 - OK"
  }
}

Update User Metadata​

To update the user metadata, make a call like this curl example:

curl -X PUT -H 'X-API-TOKEN: yourtokenhere'  -H 'Content-Type: application/json' -d '{
    "keyA": "myNewValueA",
    "keyB": "myNewValueForB",
    "keyC": "myNewValC"
}' 'https://yourdatacenterid.qualtrics.com/API/v3/users/{userID}/metadata'

A successful update will return a meta object:

{
  "meta": {
    "httpStatus": "200 - OK"
  }
}

Metadata Initialization​

This API will initialize metadata on Users, if and only if uniqueId is not enabled for the brand. Otherwise, the User must contain pre-existing associated metadata in order to edit or append new metadata via this API.

4. XM Discover APIs​

The XM Discover API exposes key functionality of the XM Discover solution for use in third-party applications. The API enables developers to access the sentiment and text analytics capabilities of the XM Discover engine.

Export API V2​

Import API​

Import a Single Record​

Import Multiple Records​