The Qualtrics REST API allows you to query our system using a simple URL syntax. All requests are simple GET or POST requests that return XML or JSON. The REST API allows you to interact with any part of the Qualtrics system allowing for full integration with our client’s systems.

Making a Request
To make a request to the API you need both a root URL and some basic parameters.
Root URL

The root URL for communicating with the Qualtrics system is:

https://yourdatacenterid.qualtrics.com/WRAPI/SiteIntercept/api.php

To find the correct value for yourdatacenterid please follow these instructions (Note these instructions are from the most recent version of the API).

Please note the use of the https protocol.  This ensures that all data that travels between the server and your program are encrypted.  This protects your credentials and the transmitted data.
Parameters

The parameters are passed using the standard query string syntax. All parameters and values are case sensitive. For more information see Query String Documentation: http://en.wikipedia.org/wiki/Query_string

The data can be passed in the URL itself (GET parameters) or be passed in the body of the request (POST parameters).  Both methods follow the same query string syntax.

Example:
https://yourdatacenterid.qualtrics.com/WRAPI/SiteIntercept/api.php?Request=getLegacyResponseData&User=apiuser&Token=lksjdfJdJklajdf3asdae3&Format=XML&SurveyID=SV_123456789

JSON parameters
Parameters may also be passed as JSON data through the request body. If using a JSON request body, you must specify a Content-Type header of 'application/json' or 'text/json'. You may use both url parameters and JSON parameters with the same request.

Example:
Request URI:	https://yourdatacenterid.qualtrics.com/WRAPI/SiteIntercept/api.php?Request=getLegacyResponseData&Format=XML
Content-Type:	application/json
Request Body:	{"User":"apiuser","Token":"lksjdfJdJklajdf3asdae3","SurveyID":"SV_123456789"}


Required Parameters

The following parameters are required for all requests:


	
Parameter
Description
	

		
Request
The name of the API call to be made.
		
User
Qualtrics username.
		
Token
Qualtrics API token (see The Token).
		
Format
The format of the response. Valid value are XML, JSON or PPJSON (Pretty Print Formatted JSON) unless otherwise noted.
		
Version
The version of the API to use.
	


Each individual request will have additional required parameters in addition to the above required parameters.


The Response
When a request is made to the API, it is processed and a response is returned.  The response will always have two sections. The first is the 'Meta' section where information about the success or failure of the request is stored. The other is the 'Result' section where the request specific response is found. The response will come back in the format you specified with your request.

CR This indicates that the request has a custom response format and does not follow the standard.

Note: If an error occurs and the 'Format' parameter is missing, invalid, or a custom format for a request then the error format will be XML.

Example Responses:


XML:

<xml>
	<Meta>
		<Status>Success</Status>
	</Meta>
	<Result>
		...
	</Result>
<xml>

or

JSON:

{
	Meta: {
		Status : "Failed",
		ErrorCode: 400,
		ErrorMessage : "Missing parameter 'Version'."
	},
	Result : {
		...
	}
}

HTTP Result Codes

In the event of an error or redirect the Qualtrics API will attempt to return an appropriate HTTP error code.


	

	

		
302/307 (Redirect)
The request should be redirected to a new address.
		
400 (Bad Request)
The request was invalid, because of missing or invalid parameters.
		
401 (Unauthorized)
Authentication failed. For more details on authentication see Authentication.
		
403 (Forbidden)	
The user provided does not have permission to make the desired request.
		
404 (Not Found)
The specified request does not exists.
		
500 (Internal Server Error)
An unknown error occurred. Try the request later.
	



Example Request
The following is an example request to get basic information about a user.

URL:

https://new.qualtrics.com/WRAPI/SiteIntercept/api.php?Request=getUserInfo&User=apiuser&Token=lksjdfJdJklajdf3asdae3&Format=XML

Response:

<xml>
	<Meta>
		<Status>Success</Status>
	</Meta>
	<Result>
		<UserID>UR_12345678</UserID>
		<UserName>apiuser</UserName>
		<UserFirstName>John</UserFirstName>
		<UserLastName>Doe</UserLastName>
		<UserEmail>johndoe@example.com</UserFirstName>
		<UserLanguage>EN</UserLanguage>
		<Libraries>
			...
		</LIbraries>
		...
	</Result>
<xml>



Redirects

The API can redirect you to a new address. The redirect is done with the appropriate header and HTTP code. This is done to ensure you are requesting the data from the location most appropriate for you. You should make sure your client expects and honors these potential redirects.

The Qualtrics REST API allows you to query our system using a simple URL syntax. All requests are simple GET or POST requests that return XML or JSON. The REST API allows you to interact with any part of the Qualtrics system allowing for full integration with our client’s systems.

Making a Request
To make a request to the API you need both a root URL and some basic parameters.
Root URL

The root URL for communicating with the Qualtrics system is:

https://yourdatacenterid.qualtrics.com/WRAPI/SiteIntercept/api.php

To find the correct value for yourdatacenterid please follow these instructions (Note these instructions are from the most recent version of the API).

Please note the use of the https protocol.  This ensures that all data that travels between the server and your program are encrypted.  This protects your credentials and the transmitted data.
Parameters

The parameters are passed using the standard query string syntax. All parameters and values are case sensitive. For more information see Query String Documentation: http://en.wikipedia.org/wiki/Query_string

The data can be passed in the URL itself (GET parameters) or be passed in the body of the request (POST parameters).  Both methods follow the same query string syntax.

Example:
https://yourdatacenterid.qualtrics.com/WRAPI/SiteIntercept/api.php?Request=getLegacyResponseData&User=apiuser&Token=lksjdfJdJklajdf3asdae3&Format=XML&SurveyID=SV_123456789

JSON parameters
Parameters may also be passed as JSON data through the request body. If using a JSON request body, you must specify a Content-Type header of 'application/json' or 'text/json'. You may use both url parameters and JSON parameters with the same request.

Example:
Request URI:	https://yourdatacenterid.qualtrics.com/WRAPI/SiteIntercept/api.php?Request=getLegacyResponseData&Format=XML
Content-Type:	application/json
Request Body:	{"User":"apiuser","Token":"lksjdfJdJklajdf3asdae3","SurveyID":"SV_123456789"}


Required Parameters

The following parameters are required for all requests:


	
Parameter
Description
	

		
Request
The name of the API call to be made.
		
User
Qualtrics username.
		
Token
Qualtrics API token (see The Token).
		
Format
The format of the response. Valid value are XML, JSON or JSONP unless otherwise noted.
		
Version
The version of the API to use.
		
JSONPCallback
Only required when Format is JSONP. The JSONP technique may be used by specifying a JavaScript callback.
	


Each individual request will have additional required parameters in addition to the above required parameters.

Format Parameters

Parameters specific to a particular format.


	
Parameter
Format
Description
	

	
JSONPCallback
JSONP
Required. The callback to be used when applying the JSONP technique.
	
JSONPrettyPrint
JSON, JSONP
Optional. Outputs JSON so that it is more readable.
	


The Response
When a request is made to the API, it is processed and a response is returned.  The response will always have two sections. The first is the 'Meta' section where information about the success or failure of the request is stored. The other is the 'Result' section where the request specific response is found. The response will come back in the format you specified with your request.

CR This indicates that the request has a custom response format and does not follow the standard.

Note: If an error occurs and the 'Format' parameter is missing, invalid, or a custom format for a request then the error format will be XML.

Example Responses:


XML:

<xml>
	<Meta>
		<Status>Success</Status>
	</Meta>
	<Result>
		...
	</Result>
<xml>

or

JSON:

{
	Meta: {
		Status : "Failed",
		ErrorCode: 400,
		ErrorMessage : "Missing parameter 'Version'."
	},
	Result : {
		...
	}
}

HTTP Result Codes

In the event of an error or redirect the Qualtrics API will attempt to return an appropriate HTTP error code.


	

	

		
302/307 (Redirect)
The request should be redirected to a new address.
		
400 (Bad Request)
The request was invalid, because of missing or invalid parameters.
		
401 (Unauthorized)
Authentication failed. For more details on authentication see Authentication.
		
403 (Forbidden)	
The user provided does not have permission to make the desired request.
		
404 (Not Found)
The specified request does not exists.
		
500 (Internal Server Error)
An unknown error occurred. Try the request later.
	



Example Request
The following is an example request to get basic information about a user.

URL:

https://new.qualtrics.com/WRAPI/SiteIntercept/api.php?Request=getUserInfo&User=apiuser&Token=lksjdfJdJklajdf3asdae3&Format=XML

Response:

<xml>
	<Meta>
		<Status>Success</Status>
	</Meta>
	<Result>
		<UserID>UR_12345678</UserID>
		<UserName>apiuser</UserName>
		<UserFirstName>John</UserFirstName>
		<UserLastName>Doe</UserLastName>
		<UserEmail>johndoe@example.com</UserFirstName>
		<UserLanguage>EN</UserLanguage>
		<Libraries>
			...
		</LIbraries>
		...
	</Result>
<xml>



Redirects

The API can redirect you to a new address. The redirect is done with the appropriate header and HTTP code. This is done to ensure you are requesting the data from the location most appropriate for you. You should make sure your client expects and honors these potential redirects.

The Qualtrics REST API allows you to query our system using a simple URL syntax. All requests are simple GET or POST requests that return XML or JSON. The REST API allows you to interact with any part of the Qualtrics system allowing for full integration with our client’s systems.

Making a Request
To make a request to the API you need both a root URL and some basic parameters.
Root URL

The root URL for communicating with the Qualtrics system is:

https://yourdatacenterid.qualtrics.com/WRAPI/SiteIntercept/api.php

To find the correct value for yourdatacenterid please follow these instructions (Note these instructions are from the most recent version of the API).

Please note the use of the https protocol.  This ensures that all data that travels between the server and your program are encrypted.  This protects your credentials and the transmitted data.
Parameters

The parameters are passed using the standard query string syntax. All parameters and values are case sensitive. For more information see Query String Documentation: http://en.wikipedia.org/wiki/Query_string

The data can be passed in the URL itself (GET parameters) or be passed in the body of the request (POST parameters).  Both methods follow the same query string syntax.

Example:
https://yourdatacenterid.qualtrics.com/WRAPI/SiteIntercept/api.php?Request=getLegacyResponseData&User=apiuser&Token=lksjdfJdJklajdf3asdae3&Format=XML&SurveyID=SV_123456789

JSON parameters
Parameters may also be passed as JSON data through the request body. If using a JSON request body, you must specify a Content-Type header of 'application/json' or 'text/json'. You may use both url parameters and JSON parameters with the same request.

Example:
Request URI:	https://yourdatacenterid.qualtrics.com/WRAPI/SiteIntercept/api.php?Request=getLegacyResponseData&Format=XML
Content-Type:	application/json
Request Body:	{"User":"apiuser","Token":"lksjdfJdJklajdf3asdae3","SurveyID":"SV_123456789"}


Required Parameters

The following parameters are required for all requests:


	
Parameter
Description
	

		
Request
The name of the API call to be made.
		
User
Qualtrics username.
		
Token
Qualtrics API token (see The Token).
		
Format
The format of the response. Valid value are XML, JSON or JSONP unless otherwise noted.
		
Version
The version of the API to use.
		
JSONPCallback
Only required when Format is JSONP. The JSONP technique may be used by specifying a JavaScript callback.
	


Each individual request will have additional required parameters in addition to the above required parameters.

Format Parameters

Parameters specific to a particular format.


	
Parameter
Format
Description
	

	
JSONPCallback
JSONP
Required. The callback to be used when applying the JSONP technique.
	
JSONPrettyPrint
JSON, JSONP
Optional. Outputs JSON so that it is more readable.
	


The Response
When a request is made to the API, it is processed and a response is returned.  The response will always have two sections. The first is the 'Meta' section where information about the success or failure of the request is stored. The other is the 'Result' section where the request specific response is found. The response will come back in the format you specified with your request.

CR This indicates that the request has a custom response format and does not follow the standard.

Note: If an error occurs and the 'Format' parameter is missing, invalid, or a custom format for a request then the error format will be XML.

Example Responses:


XML:

<xml>
	<Meta>
		<Status>Success</Status>
	</Meta>
	<Result>
		...
	</Result>
<xml>

or

JSON:

{
	Meta: {
		Status : "Failed",
		ErrorCode: 400,
		ErrorMessage : "Missing parameter 'Version'."
	},
	Result : {
		...
	}
}

HTTP Result Codes

In the event of an error or redirect the Qualtrics API will attempt to return an appropriate HTTP error code.


	

	

		
302/307 (Redirect)
The request should be redirected to a new address.
		
400 (Bad Request)
The request was invalid, because of missing or invalid parameters.
		
401 (Unauthorized)
Authentication failed. For more details on authentication see Authentication.
		
403 (Forbidden)	
The user provided does not have permission to make the desired request.
		
404 (Not Found)
The specified request does not exists.
		
500 (Internal Server Error)
An unknown error occurred. Try the request later.
	



Example Request
The following is an example request to get basic information about a user.

URL:

https://new.qualtrics.com/WRAPI/SiteIntercept/api.php?Request=getUserInfo&User=apiuser&Token=lksjdfJdJklajdf3asdae3&Format=XML

Response:

<xml>
	<Meta>
		<Status>Success</Status>
	</Meta>
	<Result>
		<UserID>UR_12345678</UserID>
		<UserName>apiuser</UserName>
		<UserFirstName>John</UserFirstName>
		<UserLastName>Doe</UserLastName>
		<UserEmail>johndoe@example.com</UserFirstName>
		<UserLanguage>EN</UserLanguage>
		<Libraries>
			...
		</LIbraries>
		...
	</Result>
<xml>



Redirects

The API can redirect you to a new address. The redirect is done with the appropriate header and HTTP code. This is done to ensure you are requesting the data from the location most appropriate for you. You should make sure your client expects and honors these potential redirects.

The Qualtrics REST API allows you to query our system using a simple URL syntax. All requests are simple GET or POST requests that return XML or JSON. The REST API allows you to interact with any part of the Qualtrics system allowing for full integration with our client’s systems.

Making a Request
To make a request to the API you need both a root URL and some basic parameters.
Root URL

The root URL for communicating with the Qualtrics system is:

https://yourdatacenterid.qualtrics.com/WRAPI/SiteIntercept/api.php

To find the correct value for yourdatacenterid please follow these instructions (Note these instructions are from the most recent version of the API).

Please note the use of the https protocol.  This ensures that all data that travels between the server and your program are encrypted.  This protects your credentials and the transmitted data.
Parameters

The parameters are passed using the standard query string syntax. All parameters and values are case sensitive. For more information see Query String Documentation: http://en.wikipedia.org/wiki/Query_string

The data can be passed in the URL itself (GET parameters) or be passed in the body of the request (POST parameters).  Both methods follow the same query string syntax.

Example:
https://yourdatacenterid.qualtrics.com/WRAPI/SiteIntercept/api.php?Request=getLegacyResponseData&User=apiuser&Token=lksjdfJdJklajdf3asdae3&Format=XML&SurveyID=SV_123456789

JSON parameters
Parameters may also be passed as JSON data through the request body. If using a JSON request body, you must specify a Content-Type header of 'application/json' or 'text/json'. You may use both url parameters and JSON parameters with the same request.

Example:
Request URI:	https://yourdatacenterid.qualtrics.com/WRAPI/SiteIntercept/api.php?Request=getLegacyResponseData&Format=XML
Content-Type:	application/json
Request Body:	{"User":"apiuser","Token":"lksjdfJdJklajdf3asdae3","SurveyID":"SV_123456789"}


Required Parameters

The following parameters are required for all requests:


	
Parameter
Description
	

		
Request
The name of the API call to be made.
		
User
Qualtrics username.
		
Token
Qualtrics API token (see The Token).
		
Format
The format of the response. Valid value are XML, JSON or JSONP unless otherwise noted.
		
Version
The version of the API to use.
		
JSONPCallback
Only required when Format is JSONP. The JSONP technique may be used by specifying a JavaScript callback.
	


Each individual request will have additional required parameters in addition to the above required parameters.

Format Parameters

Parameters specific to a particular format.


	
Parameter
Format
Description
	

	
JSONPCallback
JSONP
Required. The callback to be used when applying the JSONP technique.
	
JSONPrettyPrint
JSON, JSONP
Optional. Outputs JSON so that it is more readable.
	


The Response
When a request is made to the API, it is processed and a response is returned.  The response will always have two sections. The first is the 'Meta' section where information about the success or failure of the request is stored. The other is the 'Result' section where the request specific response is found. The response will come back in the format you specified with your request.

CR This indicates that the request has a custom response format and does not follow the standard.

Note: If an error occurs and the 'Format' parameter is missing, invalid, or a custom format for a request then the error format will be XML.

Example Responses:


XML:

<xml>
	<Meta>
		<Status>Success</Status>
	</Meta>
	<Result>
		...
	</Result>
<xml>

or

JSON:

{
	Meta: {
		Status : "Failed",
		ErrorCode: 400,
		ErrorMessage : "Missing parameter 'Version'."
	},
	Result : {
		...
	}
}

HTTP Result Codes

In the event of an error or redirect the Qualtrics API will attempt to return an appropriate HTTP error code.


	

	

		
302/307 (Redirect)
The request should be redirected to a new address.
		
400 (Bad Request)
The request was invalid, because of missing or invalid parameters.
		
401 (Unauthorized)
Authentication failed. For more details on authentication see Authentication.
		
403 (Forbidden)	
The user provided does not have permission to make the desired request.
		
404 (Not Found)
The specified request does not exists.
		
500 (Internal Server Error)
An unknown error occurred. Try the request later.
	



Example Request
The following is an example request to get basic information about a user.

URL:

https://new.qualtrics.com/WRAPI/SiteIntercept/api.php?Request=getUserInfo&User=apiuser&Token=lksjdfJdJklajdf3asdae3&Format=XML

Response:

<xml>
	<Meta>
		<Status>Success</Status>
	</Meta>
	<Result>
		<UserID>UR_12345678</UserID>
		<UserName>apiuser</UserName>
		<UserFirstName>John</UserFirstName>
		<UserLastName>Doe</UserLastName>
		<UserEmail>johndoe@example.com</UserFirstName>
		<UserLanguage>EN</UserLanguage>
		<Libraries>
			...
		</LIbraries>
		...
	</Result>
<xml>



Redirects

The API can redirect you to a new address. The redirect is done with the appropriate header and HTTP code. This is done to ensure you are requesting the data from the location most appropriate for you. You should make sure your client expects and honors these potential redirects.