The Qualtrics REST API allows you to query our system using a simple URL syntax. The REST API allows you to interact with any part of the Qualtrics system allowing for full integration with our client’s systems.REST Input ParametersRoot URLsThe root URL for communicating with the Qualtrics system is: https://new.qualtrics.com/WRAPI/ThreeSixty/api.php 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.ParametersThe parameters are passed using the standard query string syntax. All parameters and values are case sensitive. 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://new.qualtrics.com/WRAPI/ThreeSixty/api.php?Request=getResponseData&Token=lksjdfJdJklajdf3asdae3&SurveyID=SV_123456789&Format=XMLRequired ParametersThe following parameters are required for all requests:
| Parameter | Description |
|---|---|
| Request | The name of the API call to be made. |
| User | Qualtrics username. |
| Password | Qualtrics password. |
| Header | Description |
|---|---|
| RequestStatus | The status of the request. If “Success” then the request was received and processed correctly. If “Failure” there was an error processing the request. |
Returns a CSV containing the Response Status for the specified Pulse
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 1.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the project for which you want the response status. | |
| PulseID | <String> | Yes | The ID of the pulse for which you want the response status. | |
| Questions | <String>%2C<String> | No | A comma separated list of Question IDs. Will filter the data to only include those specific questions, if IncludeEvaluationResponses is enabled. |
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 RequestTo make a request to the API you need both a root URL and some basic parameters.Root URLThe root URL for communicating with the Qualtrics system is: https://yourdatacenterid.qualtrics.com/WRAPI/ThreeSixty/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.ParametersThe 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/ThreeSixty/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/ThreeSixty/api.php?Request=getLegacyResponseData&Format=XML Content-Type: application/json Request Body: {"User":"apiuser","Token":"lksjdfJdJklajdf3asdae3","SurveyID":"SV_123456789"}Required ParametersThe 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. |
| 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. |
The API uses a token based authentication system. This prevents you from needing to give out your password to third parties. Qualtrics needs both your user name and your token to authenticate your request. A request will be authenticated if a valid user name and token pair are passed as the 'User' and 'Token' parameters. Each Qualtrics user account can have one and only one token associated with it. The token never expires and can be regenerated at any time. To generate/regenerate your token:
This request activates an Orginization (Brand).
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | Yes | The Orginization ID |
Changes the user name from the old to the new user name
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OldUserName | <String> | Yes | The user name to be changed | |
| NewUserName | <String> | Yes | The new user name | |
| UserNameIsEmail | [0,1] | No | 1 | Default is 1. If 1 the user name must be an email address and the user’s email address will be updated in the system. It is strongly recommended to use email addresses as the user name. |
This request creates a new Division for a given Organization
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| DivisionID | <String> | No | If specified, will use this DivisionID | |
| Name | <String> | Yes | The name of this Division | |
| DivisionAdmins | <String> | No | The UserIDs of the desired Division Admins, passed as an array |
Create a new user
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| NewUsername | <String> | Yes | The name of the new user | |
| NewPassword | <String> | Yes | Password of new user | |
| FirstName | <String> | Yes | User’s first name | |
| LastName | <String> | Yes | User’s last name | |
| <String> | Yes | User’s email | ||
| Organization | <String> | Yes | Organization ID (Brand ID) | |
| Type | <String> | Yes | User Type | |
| DivisionID | <String> | No | Division ID |
This request deactivates an Orginization (Brand).
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | Yes | The Orginization ID |
Allows a 3rd party to check the status of all their subscriptions.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. |
Allows a 3rd party to check the status of a subscription.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber |
Gets all the User IDs for a Brand and/or Division To use this you must be the organization administrator or higher.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Organization | <String> | No | Specifies the Organization ID from which to obtain the User IDs. | |
| Division | <String> | No | (Optional) Specifies the Division ID from which to filter the User IDs. | |
| Offset | <String> | No | The index from which to begin the search. (Requires that a limit is provided as well) | |
| Limit | <String> | No | The maximum number of users to return. | |
| IncludeUserStats | [0,1] | No | 0 | (Optional) Set to 1 to include additional details and usage stats, including: total number of surveys, number of active surveys, and last survey response date. Note that this can significantly increase response time for especially large brands |
Allows a 3rd party client to subscribe to Qualtrics events. Topic subscription can be a single event * (Ex: 'threesixty.created') or a wildcard list of events using the * (star) notation to denote 'everything' (Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics.) Qualtrics Events include (but are not limited to): controlpanel.activateSurvey
| Attribute | Type | Description |
|---|---|---|
| Status | String | Active or Inactive, the result will be 'Active' if successful. |
| SurveyID | GUID | The Survey ID of the survey that has been activated |
| Attribute | Type | Description |
|---|---|---|
| Status | String | Active or Inactive, the result will be 'Inactive' if successful. |
| SurveyID | GUID | The Survey ID of the survey that has been deactivated |
| Attribute | Type | Description |
|---|---|---|
| Status | String | The status will always be Compete if successful. |
| SurveyID | GUID | The Survey ID of the survey whose response has been completed. |
| ResponseID | GUID | The Response ID of the response that has been completed. |
| RecipientID | GUID | The Recipient ID of the response that has been completed. Will only be included if non-null |
| ResponseEventContext | String | Custom context that can be set via the ResponseEventContext embeded data. 50 character limit |
| Attribute | Type | Description |
|---|---|---|
| Status | String | The status will always be Partial if successful. |
| SurveyID | GUID | The Survey ID of the survey whose partial response has been saved. |
| ResponseID | GUID | The Response ID of the response that has been recorded. |
| RecipientID | GUID | The Recipient ID of the response that has been recorded. Will only be included if non-null |
| ResponseEventContext | String | Custom context that can be set via the ResponseEventContext embeded data. 50 character limit |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The 360 the nomination was created for |
| SubjectID | GUID | The PersonID of the one doing the nominating; the one that will be evaluated |
| EvaluatorID | GUID | The PersonID of the one being nominated that will perform the evaluation |
| EvaluatorEmail | String | The Email Address of the person that will perform the evaluation |
| Relationship | String | The Relationship of the nomination |
| EvaluationURL | String | The Link to perform the evaluation (Survey Engine Link) |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The 360 the nomination was removed for |
| SubjectID | GUID | The PersonID of the one doing the nominating; the one that was to be evaluated |
| EvaluatorID | GUID | The PersonID of the one being nominated that was to perform the evaluation |
| Relationship | String | The Relationship of the nomination |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the newly-created 360 |
| SurveyID | GUID | The ID of associated survey |
| Workflow | JSON | The Workflow Settings |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the newly-created 360 |
| SubjectID | GUID | The PersonID of the person being evaluated |
| EvaluatorID | GUID | The PersonID of the one performing the evaluation |
| Status | String | The Status of the evaluation (Started, Finished) |
| SessionID | GUID | The SessionID of the initiated open survey session |
| ResponseID | GUID | (Optionally - When Finished) The ID of the Response |
| Relationship | String | The Relationship of the evaluation |
| Unsolicitied | Boolean | (Optionally - When Finished) Boolean TRUE if the response was unsolicited, FALSE otherwise |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| SubjectID | GUID | The PersonID of the subject of the report |
| ReportURL | String | The URL to view the report (Currently the link to log in to the Qualtrics Portal to view the report) |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| Status | String | Active or Inactive |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| SubjectID | GUID | The Person ID of the Subject |
| Status | String | Done or Waiting (Not Done) |
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber (we will make sure this is globally unique. All callers of this just need to ensure they are locally-unique.) | |
| PublicationURL | <URL> | Yes | The FULLY-Qualified URL to publish events to. For Example, if "http://mydomain.com/REST.php" it will publish messages to you via HTTP REST. The data pushed to the publication URL will be of Content-Type: application/x-www-urlencoded, NOT Content-Type: application/json | |
| Topics | <String> | Yes | String Value of Topics to subscribe to. Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics. | |
| Encrypt | [0,1] | No | 0 | If true, will encrypt the event messages using the supplied Shared Key. Encryption will be AES 128 or 256 depending on Shared Key length (16 bytes = 128 bit, 32 bytes = 256 bit). Encryption is not necessary if publishing to an https URL. * Encrypted MSG is Base64 encoded for transport purposes, therefore you must base64 decode the MSG before decrypting it. MSG plaintext will be in JSON format. |
| SharedKey | <String> | No | If specified, all event messages will be emitted with an HMAC using this key to guarantee message authenticity, and optionally encrypted using this key (if Encrypt = true). | |
| BrandID | <String> | No | If specified, subscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Allows a 3rd party client to unsubscribe to Qualtrics events. Any queued messages that have not been sent for that subscription will be deleted.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber | |
| BrandID | <String> | No | If specified, unsubscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Allows a 3rd party client to unsubscribe from all Qualtrics events.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | No | If specified, unsubscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Updates the specified User's information, based on UserID. To use this you must be the organization administrator or higher. For security reasons, you cannot set passwords for users other than yourself.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| UserID | <String> | Yes | ID of the user | |
| FirstName | <String> | No | First Name of user | |
| LastName | <String> | No | Last Name of user | |
| NewUsername | <String> | No | New Username of user | |
| NewPassword | <String> | No | New Password of user (can only set your own) | |
| <String> | No | New Email of user | ||
| Division | <String> | No | New Division ID of user | |
| UserType | <String> | No | New User Type | |
| Status | {Active, Disabled, NotVerified} | No | Updated Status for the user | |
| Permissions | <String> | No | JSON String representing the user permissions |
This request creates a new Message
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| Name | <String> | Yes | If specified, the name of the message | |
| Category | {InviteEmails, InactiveSurveyMessages, ReminderEmails, ThankYouEmails, EndOfSurveyMessages, GeneralMessages, ValidationMessages, LookAndFeelMessages, EmailSubject, SMSInvite, SMSReminder, SMSThankYou, TicketMessages} | Yes | The category of the new message | |
| Message | <String> | Yes | The text of the message to set; either an array mapping language codes to messages, or a single message to be set using the Language parameter | |
| Language | <String> | No | If specified, will set the translation in the specified language |
This request fetches the designated Message file
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| MessageID | <String> | Yes | The ID of the Message desired | |
| Language | <String> | No | If specified, will fetch the translation in the specified language (if available) |
Returns a list of library message ids.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message |
This request sets the designated Message text
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| MessageID | <String> | Yes | The ID of the Message desired | |
| Language | <String> | No | If specified, will set the translation in the specified language | |
| Message | <String> | Yes | The text of the message to set; either an array mapping language codes to messages, or a single message to be set using the Language parameter | |
| Name | <String> | No | If specified, will rename the message |
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ReportID | <String> | Yes | The Report ID for the report containing the Predefined Data Source.) | |
| DataSourceID | <String> | Yes | The Data Source ID for the Predefined Data Source to be updated. | |
| PredefinedData | <String> | No | A string of JSON-encoded predefined data to update the data source with | |
| URL | <URL> | No | The URL of an JSON file containing the new Data Source data |
Returns all of the response data for a survey in the original (legacy) data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, CSV, HTML, JSON} | Yes | The format the data will be transmitted in. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The survey you will be getting the responses for. | |
| LastResponseID | <String> | No | Each response is recorded sequentially. When specified it will export all responses after the id specified. | |
| Limit | <String> | No | The maximum number of responses to return. | |
| Offset | <String> | No | The starting index (inclusive) from which the responses will be retrieved. Combine with Limit to acheive pagination for responses in progress only. | |
| ResponseID | <String> | No | The response id of an individual response. ResponseSetID, SubgroupID, StartDate, and EndDate should not be specified when using this parameter. | |
| ResponseSetID | <String> | No | The response set you want to retrieve the data from. If not specified it will use the default response set. | |
| SubgroupID | <String> | No | The subgroup you want to download the data for. | |
| StartDate | YYYY-MM-DD hh:mm:ss | No | The date the responses must be after. | |
| EndDate | YYYY-MM-DD hh:mm:ss | No | The date the responses must be before. | |
| Questions | <String>%2C<String> | No | A comma separated list of question ids. Will filter the data to only include those specific questions. | |
| Labels | [0,1] | No | 0 | If 1 (true) the label for choices and answers will be used and not the id. The default is 0. |
| ExportTags | [0,1] | No | 0 | If 1 (true) the export tags will be used rather than the V labels. The default is 0. |
| ExportQuestionIDs | [0,1] | No | 0 | If 1 (true) the internal question IDs will be used rather than export tags or the V labels. The default is 0. |
| LocalTime | [0,1] | No | 1 | If 1 {true} the StartDate and EndDate will be exported using the specified user’s local time zone. |
| UnansweredRecode | <String> | No | The recode value for seen but unanswered questions. If not specified a blank value is put in for these questions. | |
| PanelID | <String> | No | If supplied it will only get the results for members of that specific panel. | |
| ResponsesInProgress | [0,1] | No | 0 | If 1 (true), will retrieve the responses in progress (and only the responses in progress). |
| LocationData | [0,1] | No | 0 | If 1 (true), will export location data. |
This request imports responses into the specified Employee Insights project. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format. The expected format of the file contents is the same format as the 'Evaluation Status' download with 'Include Response Data' checked.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the 360 into which we want to import responses. | |
| PulseID | <String> | No | The ID of the Pulse into which we want to import responses. | |
| URL | <URL> | No | If present it will import the file from the given url. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data |
Activates the specified Survey
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The Survey ID to activate |
Deactivates the specified Survey
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The Survey ID to deactivate |
Delete the specified survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | ID of the survey |
Returns an HTML respresentation of the given response
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The response's associated survey ID | |
| ResponseID | <String> | Yes | The response to get HTML for | |
| ExcludeED | [0,1] | No | 0 | 1 to exclude embedded data. |
| ExcludeScoring | [0,1] | No | 0 | 1 to exclude scoring information. |
| ExcludeHiddenQuestions | [0,1] | No | 0 | 1 to exclude questions not displayed to the recipient. |
| ExcludeLocation | [0,1] | No | 0 | 1 to exclude location information. |
| IncludeHeader | [0,1] | No | 0 | 1 to include the header. |
This request returns an xml export of the survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the survey whose xml definition will be retrieved. | |
| Language | <String> | No | The language code for the language you want to export the survey in. If not specified it will use the default language. Qualtrics generally adheres to the ISO 639-1 Standard for 2 character Language codes (http://en.wikipedia.org/wiki/ISO_639-1, ex. EN = English, ES = Spanish, DE = German). | |
| ExportLogic | [0,1] | No | 0 | EXPERIMENTAL. This is an experimental feature and subject to change without notice. Default 0. If 1 it will export the logic. |
This request returns the name of the survey as well as some addition information
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the survey. | |
| Language | <String> | No | The language code for the language you want to export the survey in. If not specified it will use the default language. |
This request returns a list of all the surveys for the user.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. |
This request imports a survey using the TXT or JSON format. The API assumes the file data was submitted in the POST. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ImportFormat | {TXT, QSF, DOC, MSQ} | No | TXT | The format of the import. |
| Name | <String> | Yes | The survey name. | |
| Activate | [0,1] | No | 0 | If FALSE (0) will be created in an Inactive state. If TRUE (1) will be created in an active state. |
| URL | <URL> | No | If present it will import the file from the given URL. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| OwnerID | <String> | No | UserID of caller | Specify the owner of this survey (a valid UserID or BrandID, Division and Group owned surveys are deprecated). Default owner is the user making this call. |
This request imports a set of survey translations using the CSV or XML format. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the Survey for which we are updating translations. | |
| URL | <URL> | No | If present it will import the file from the given URL. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| AsAdmin | [0,1] | No | TRUE if making this call on behalf of a survey that is owned by someone else in your org (As an Admin) |
Sets the survey options.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The survey options to be changed. | |
| Active | [0,1] | No | Activates or Deactivates the survey if specified. | |
| CloseSessions | [0,1] | No | 1 | When Active=0 this can be used to close all active sessions. |
| Expiration | [0,1] | No | Allows the survey to expire. The survey will only be valid between ExpirationStartDate and ExpirationEndDate. | |
| ExpirationStartDate | YYYY-MM-DD hh:mm:ss | No | When Expiration=1 the first date the survey will be valid. | |
| ExpirationEndDate | YYYY-MM-DD hh:mm:ss | No | When Expiration=1 the last date day the survey will be valid. | |
| SourceTimeZone | <String> | No |
This request transfers survey ownership to the specified user
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the Survey to change ownership | |
| SurveyName | <String> | No | The new name of the survey, if left empty will keep the current name | |
| OwnerID | <String> | Yes | The original owner of the survey | |
| NewOwnerID | <String> | Yes | The user that will receive ownership |
This request adds a person to a 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| PersonID | <String> | Yes | The Person ID | |
| ThreeSixtyID | <String> | Yes | The 360 you will be adding the person to. | |
| External | [0,1] | No | 0 | Denotes whether a person is external to the 360 (1 == external). Defaults to 0 if not present. For EE projects always set external = 1. |
| ForceUpdate | [0,1] | No | 0 | If the person is already in the assessment, this forces an update of the externality of the person specified. Defaults to 0 (just skip). |
This request creates a new person in the provided Organization Structure
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| <String> | Yes | The email for the new person, will also be the username | ||
| FirstName | <String> | Yes | The first name of the new person. | |
| LastName | <String> | Yes | The last name for the new person. | |
| UserName | <String> | No | Optionally specify the username of the person you are creating. Defaults to the email. | |
| OrgStructureID | <String> | No | The organization structure ID | |
| PersonID | <String> | No | The PersonID for the person to be created must be valid unused person GUID | |
| DivisionID | <String> | No | The division if wanted to place the new person/user in | |
| External | [0,1] | No | 0 | Is the person an external? 1== external, 0 == not external |
| MetaData | <String> | No | The custom MetaData for the new person passed as an array |
** DEPRECATED in 2.3. Use CreateAssessment instead.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | The name of the assessment. | |
| ThreeSixtyID | <String> | No | If supplied, will use this ID for the newly-created assessment. | |
| OwnerID | <String> | No | The owner of the assessment (User ID, Group ID or Division ID). | |
| SurveyID | <String> | No | If supplied, will associate this Form ID with this assessment, and not create a new form. | |
| WorkFlowOptions | <String> | No | Optional workflow options. | |
| Relationships | <String> | No | Optional relationships this assessment will use. | |
| NewAssessment | [0,1] | No | 0 | The type of Assessment to create. defaults to a classic threesixty (false) true creates a new Assessment |
This request deletes the specified user.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| UserID | <String> | Yes | The ID of the user you would like to delete. |
This request returns the custom relationships for a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The 360 ID |
This request returns all persons in the organization
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | No | The organization structure ID | |
| IncludeMetaData | [0,1] | No | 0 | If 1, includes metadata for each person |
| StartIndex | <String> | No | 0 | The start index |
| RecordLimit | <String> | No | The maximum number of records to return. Defaults to unlimited. |
This request returns the persons in the organization below the specified person
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | Yes | The organization structure ID | |
| PersonID | <String> | Yes | Everyone below this person |
Returns a CSV containing the Response Status for the specified Pulse
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 1.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the project for which you want the response status. | |
| PulseID | <String> | Yes | The ID of the pulse for which you want the response status. | |
| Questions | <String>%2C<String> | No | A comma separated list of Question IDs. Will filter the data to only include those specific questions, if IncludeEvaluationResponses is enabled. |
This request returns a PDF of the specified person’s subject report for a given 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID | |
| PersonID | <String> | Yes | The subject of the report | |
| Viewer | <String> | No | Subject | The viewer of the report -- either a Person ID of the viewer, Admin or Subject. If a Person ID, will use that person as the viewer. If Admin, the viewer will be the person making this API call. If Subject, the viewer is the Subject PersonID specified above. |
This request returns a specified person’s subject report data for a given 360 Assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID | |
| PersonID | <String> | Yes | The subject of the report |
This request returns the export of all the subjects' status for a given 360 Assessment. Currently only CSV output format is supported.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The format the data will be transmitted in. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID |
This request imports a CSV list of persons (in batch) into the specified organization. The CSV file can be posted (there is an approximate 8 megabytes limit) or a URL can be given to retrieve the file from a remote server. The CSV file must contain a header row and be comma separated using “ for encapsulation
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | No | The organization structure ID to import the persons into. Leave blank if using ThreeSixtyID (uses the org structure ID of the assessment) | |
| ThreeSixtyID | <String> | No | The 360 you will be importing the persons into as subjects. Leave blank if you do not want them to be added as subjects | |
| URL | <String> | No | If present it will attempt to load the CSV file from the URL specified, otherwise it simply looks at the post for the data | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| Type | <String> | No | Directory | Import Type. Possible values include: Directory, Subjects or Evaluators (for 360 Projects), or Participants (for EE Projects) |
| CleanImport | [0,1] | No | If true, will remove any individuals that were not imported | |
| ClearRelationships | [0,1] | No | If true, will remove all relationships from the specified org structure before import | |
| UpdateResponses | [0,1] | No | If true, will update any responses given by the updated individuals with the metadata uploaded | |
| UseUniquePersonID | [0,1] | No | If true, will update any persons based on looking them up via the unique person id specified for the organization. If false, uses Email as the unique field. This is the only way to update email addresses and corresponding usernames. | |
| NoHierarchyUpdate | [0,1] | No | 0 | If true, will not update the people in the org hierarchies for the assessment |
This request removes a person from a 360 assessment or directory. If only a ThreeSixtyID is specified, this call removes the person from the 360 assessment. If only an Org Structure ID is specified, this call removes the person from the organization directory only.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| PersonID | <String> | Yes | The PersonID for the person to be removed | |
| ThreeSixtyID | <String> | No | The 360 (TS_) assessment in which you will be removing the person | |
| OrgStructureID | <String> | No | The Org Structure (OS_) directory in which you will be removing the person | |
| RemoveEvaluations | [0,1] | No | 0 | Remove Evaluations Given By This Person? 1 == yes, 0 == no. Default is no |
This request resets a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Three Sixty to reset | |
| Cache | [0,1] | No | 0 | Clear the ThreeSixty Cache |
| Nominations | [0,1] | No | 0 | Remove all Nominations from 360 |
| Evaluations | [0,1] | No | 0 | Remove all Evaluations from 360 |
| Previews | [0,1] | No | 0 | Deletes and removes all preview survey responses from 360 |
| Participants | [0,1] | No | 0 | Remove all Participants from 360 |
| ReSync | [0,1] | No | 0 | Recalculate values and evaluations requirements |
This request sets custom relationships for a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The 360 ID | |
| jsonOfRelationships | <String> | No | The json of the custom relationships and their translations. Example:{"RL_0V8w4Pv4aBHG13n":{"EN":"Friend","ES":"Amigo "},"RL_23GpWwksHAZ053T":{"EN":"Enemy","ES":" Enemigo "},"RL_6sxXjX7aTPpvQ5n":{"EN":"Cohort","ES":" Cohorte"}}) |
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 RequestTo make a request to the API you need both a root URL and some basic parameters.Root URLThe root URL for communicating with the Qualtrics system is: https://yourdatacenterid.qualtrics.com/WRAPI/ThreeSixty/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.ParametersThe 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/ThreeSixty/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/ThreeSixty/api.php?Request=getLegacyResponseData&Format=XML Content-Type: application/json Request Body: {"User":"apiuser","Token":"lksjdfJdJklajdf3asdae3","SurveyID":"SV_123456789"}Required ParametersThe 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. |
| 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. |
| 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. |
The API uses a token based authentication system. This prevents you from needing to give out your password to third parties. Qualtrics needs both your user name and your token to authenticate your request. A request will be authenticated if a valid user name and token pair are passed as the 'User' and 'Token' parameters. Each Qualtrics user account can have one and only one token associated with it. The token never expires and can be regenerated at any time. To generate/regenerate your token:
This request activates an Orginization (Brand).
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | Yes | The Orginization ID |
Changes the user name from the old to the new user name
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OldUserName | <String> | Yes | The user name to be changed | |
| NewUserName | <String> | Yes | The new user name | |
| UserNameIsEmail | [0,1] | No | 1 | Default is 1. If 1 the user name must be an email address and the user’s email address will be updated in the system. It is strongly recommended to use email addresses as the user name. |
This request creates a new Division for a given Organization
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| DivisionID | <String> | No | If specified, will use this DivisionID | |
| Name | <String> | Yes | The name of this Division | |
| DivisionAdmins | <String> | No | The UserIDs of the desired Division Admins, passed as an array |
Create a new user
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| NewUsername | <String> | Yes | The name of the new user | |
| NewPassword | <String> | Yes | Password of new user | |
| FirstName | <String> | Yes | User’s first name | |
| LastName | <String> | Yes | User’s last name | |
| <String> | Yes | User’s email | ||
| Organization | <String> | Yes | Organization ID (Brand ID) | |
| Type | <String> | Yes | User Type | |
| DivisionID | <String> | No | Division ID |
This request deactivates an Orginization (Brand).
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | Yes | The Orginization ID |
Allows a 3rd party to check the status of all their subscriptions.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. |
Allows a 3rd party to check the status of a subscription.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber |
Gets all the User IDs for a Brand and/or Division To use this you must be the organization administrator or higher.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Organization | <String> | No | Specifies the Organization ID from which to obtain the User IDs. | |
| Division | <String> | No | (Optional) Specifies the Division ID from which to filter the User IDs. | |
| Offset | <String> | No | The index from which to begin the search. (Requires that a limit is provided as well) | |
| Limit | <String> | No | The maximum number of users to return. | |
| IncludeUserStats | [0,1] | No | 0 | (Optional) Set to 1 to include additional details and usage stats, including: total number of surveys, number of active surveys, and last survey response date. Note that this can significantly increase response time for especially large brands |
Allows a 3rd party client to subscribe to Qualtrics events. Topic subscription can be a single event * (Ex: 'threesixty.created') or a wildcard list of events using the * (star) notation to denote 'everything' (Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics.) Qualtrics Events include (but are not limited to): controlpanel.activateSurvey
| Attribute | Type | Description |
|---|---|---|
| Status | String | Active or Inactive, the result will be 'Active' if successful. |
| SurveyID | GUID | The Survey ID of the survey that has been activated |
| Attribute | Type | Description |
|---|---|---|
| Status | String | Active or Inactive, the result will be 'Inactive' if successful. |
| SurveyID | GUID | The Survey ID of the survey that has been deactivated |
| Attribute | Type | Description |
|---|---|---|
| Status | String | The status will always be Compete if successful. |
| SurveyID | GUID | The Survey ID of the survey whose response has been completed. |
| ResponseID | GUID | The Response ID of the response that has been completed. |
| RecipientID | GUID | The Recipient ID of the response that has been completed. Will only be included if non-null |
| ResponseEventContext | String | Custom context that can be set via the ResponseEventContext embeded data. 50 character limit |
| Attribute | Type | Description |
|---|---|---|
| Status | String | The status will always be Partial if successful. |
| SurveyID | GUID | The Survey ID of the survey whose partial response has been saved. |
| ResponseID | GUID | The Response ID of the response that has been recorded. |
| RecipientID | GUID | The Recipient ID of the response that has been recorded. Will only be included if non-null |
| ResponseEventContext | String | Custom context that can be set via the ResponseEventContext embeded data. 50 character limit |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The 360 the nomination was created for |
| SubjectID | GUID | The PersonID of the one doing the nominating; the one that will be evaluated |
| EvaluatorID | GUID | The PersonID of the one being nominated that will perform the evaluation |
| EvaluatorEmail | String | The Email Address of the person that will perform the evaluation |
| Relationship | String | The Relationship of the nomination |
| EvaluationURL | String | The Link to perform the evaluation (Survey Engine Link) |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The 360 the nomination was removed for |
| SubjectID | GUID | The PersonID of the one doing the nominating; the one that was to be evaluated |
| EvaluatorID | GUID | The PersonID of the one being nominated that was to perform the evaluation |
| Relationship | String | The Relationship of the nomination |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the newly-created 360 |
| SurveyID | GUID | The ID of associated survey |
| Workflow | JSON | The Workflow Settings |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the newly-created 360 |
| SubjectID | GUID | The PersonID of the person being evaluated |
| EvaluatorID | GUID | The PersonID of the one performing the evaluation |
| Status | String | The Status of the evaluation (Started, Finished) |
| SessionID | GUID | The SessionID of the initiated open survey session |
| ResponseID | GUID | (Optionally - When Finished) The ID of the Response |
| Relationship | String | The Relationship of the evaluation |
| Unsolicitied | Boolean | (Optionally - When Finished) Boolean TRUE if the response was unsolicited, FALSE otherwise |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| SubjectID | GUID | The PersonID of the subject of the report |
| ReportURL | String | The URL to view the report (Currently the link to log in to the Qualtrics Portal to view the report) |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| Status | String | Active or Inactive |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| SubjectID | GUID | The Person ID of the Subject |
| Status | String | Done or Waiting (Not Done) |
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber (we will make sure this is globally unique. All callers of this just need to ensure they are locally-unique.) | |
| PublicationURL | <URL> | Yes | The FULLY-Qualified URL to publish events to. For Example, if "http://mydomain.com/REST.php" it will publish messages to you via HTTP REST. The data pushed to the publication URL will be of Content-Type: application/x-www-urlencoded, NOT Content-Type: application/json | |
| Topics | <String> | Yes | String Value of Topics to subscribe to. Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics. | |
| Encrypt | [0,1] | No | 0 | If true, will encrypt the event messages using the supplied Shared Key. Encryption will be AES 128 or 256 depending on Shared Key length (16 bytes = 128 bit, 32 bytes = 256 bit). Encryption is not necessary if publishing to an https URL. * Encrypted MSG is Base64 encoded for transport purposes, therefore you must base64 decode the MSG before decrypting it. MSG plaintext will be in JSON format. |
| SharedKey | <String> | No | If specified, all event messages will be emitted with an HMAC using this key to guarantee message authenticity, and optionally encrypted using this key (if Encrypt = true). | |
| BrandID | <String> | No | If specified, subscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Allows a 3rd party client to unsubscribe to Qualtrics events. Any queued messages that have not been sent for that subscription will be deleted.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber | |
| BrandID | <String> | No | If specified, unsubscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Allows a 3rd party client to unsubscribe from all Qualtrics events.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | No | If specified, unsubscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Updates the specified User's information, based on UserID. To use this you must be the organization administrator or higher. For security reasons, you cannot set passwords for users other than yourself.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| UserID | <String> | Yes | ID of the user | |
| FirstName | <String> | No | First Name of user | |
| LastName | <String> | No | Last Name of user | |
| NewUsername | <String> | No | New Username of user | |
| NewPassword | <String> | No | New Password of user (can only set your own) | |
| <String> | No | New Email of user | ||
| Division | <String> | No | New Division ID of user | |
| UserType | <String> | No | New User Type | |
| Status | {Active, Disabled, NotVerified} | No | Updated Status for the user | |
| Permissions | <String> | No | JSON String representing the user permissions |
This request creates a new Message
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| Name | <String> | Yes | If specified, the name of the message | |
| Category | {InviteEmails, InactiveSurveyMessages, ReminderEmails, ThankYouEmails, EndOfSurveyMessages, GeneralMessages, ValidationMessages, LookAndFeelMessages, EmailSubject, SMSInvite, SMSReminder, SMSThankYou, TicketMessages} | Yes | The category of the new message | |
| Message | <String> | Yes | The text of the message to set; either an array mapping language codes to messages, or a single message to be set using the Language parameter | |
| Language | <String> | No | If specified, will set the translation in the specified language |
This request fetches the designated Message file
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| MessageID | <String> | Yes | The ID of the Message desired | |
| Language | <String> | No | If specified, will fetch the translation in the specified language (if available) |
Returns a list of library message ids.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message |
This request sets the designated Message text
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| MessageID | <String> | Yes | The ID of the Message desired | |
| Language | <String> | No | If specified, will set the translation in the specified language | |
| Message | <String> | Yes | The text of the message to set; either an array mapping language codes to messages, or a single message to be set using the Language parameter | |
| Name | <String> | No | If specified, will rename the message |
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ReportID | <String> | Yes | The Report ID for the report containing the Predefined Data Source.) | |
| DataSourceID | <String> | Yes | The Data Source ID for the Predefined Data Source to be updated. | |
| PredefinedData | <String> | No | A string of JSON-encoded predefined data to update the data source with | |
| URL | <URL> | No | The URL of an JSON file containing the new Data Source data |
Returns all of the response data for a survey in the original (legacy) data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, CSV, HTML, JSON} | Yes | The format the data will be transmitted in. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The survey you will be getting the responses for. | |
| LastResponseID | <String> | No | Each response is recorded sequentially. When specified it will export all responses after the id specified. | |
| Limit | <String> | No | The maximum number of responses to return. | |
| Offset | <String> | No | The starting index (inclusive) from which the responses will be retrieved. Combine with Limit to acheive pagination for responses in progress only. | |
| ResponseID | <String> | No | The response id of an individual response. ResponseSetID, SubgroupID, StartDate, and EndDate should not be specified when using this parameter. | |
| ResponseSetID | <String> | No | The response set you want to retrieve the data from. If not specified it will use the default response set. | |
| SubgroupID | <String> | No | The subgroup you want to download the data for. | |
| StartDate | YYYY-MM-DD hh:mm:ss | No | The date the responses must be after. | |
| EndDate | YYYY-MM-DD hh:mm:ss | No | The date the responses must be before. | |
| Questions | <String>%2C<String> | No | A comma separated list of question ids. Will filter the data to only include those specific questions. | |
| Labels | [0,1] | No | 0 | If 1 (true) the label for choices and answers will be used and not the id. The default is 0. |
| ExportTags | [0,1] | No | 0 | If 1 (true) the export tags will be used rather than the V labels. The default is 0. |
| ExportQuestionIDs | [0,1] | No | 0 | If 1 (true) the internal question IDs will be used rather than export tags or the V labels. The default is 0. |
| LocalTime | [0,1] | No | 1 | If 1 {true} the StartDate and EndDate will be exported using the specified user’s local time zone. |
| UnansweredRecode | <String> | No | The recode value for seen but unanswered questions. If not specified a blank value is put in for these questions. | |
| PanelID | <String> | No | If supplied it will only get the results for members of that specific panel. | |
| ResponsesInProgress | [0,1] | No | 0 | If 1 (true), will retrieve the responses in progress (and only the responses in progress). |
| LocationData | [0,1] | No | 0 | If 1 (true), will export location data. |
This request imports responses into the specified Employee Insights project. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format. The expected format of the file contents is the same format as the 'Evaluation Status' download with 'Include Response Data' checked.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the 360 into which we want to import responses. | |
| PulseID | <String> | No | The ID of the Pulse into which we want to import responses. | |
| URL | <URL> | No | If present it will import the file from the given url. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data |
Activates the specified Survey
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The Survey ID to activate |
Deactivates the specified Survey
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The Survey ID to deactivate |
Delete the specified survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | ID of the survey |
Gets all the quotas for a given survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | Survey ID of the survey in question. You must have permission to view responses on the given survey. |
Returns an HTML respresentation of the given response
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The response's associated survey ID | |
| ResponseID | <String> | Yes | The response to get HTML for | |
| ExcludeED | [0,1] | No | 0 | 1 to exclude embedded data. |
| ExcludeScoring | [0,1] | No | 0 | 1 to exclude scoring information. |
| ExcludeHiddenQuestions | [0,1] | No | 0 | 1 to exclude questions not displayed to the recipient. |
| ExcludeLocation | [0,1] | No | 0 | 1 to exclude location information. |
| IncludeHeader | [0,1] | No | 0 | 1 to include the header. |
This request returns an xml export of the survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the survey whose xml definition will be retrieved. | |
| Language | <String> | No | The language code for the language you want to export the survey in. If not specified it will use the default language. Qualtrics generally adheres to the ISO 639-1 Standard for 2 character Language codes (http://en.wikipedia.org/wiki/ISO_639-1, ex. EN = English, ES = Spanish, DE = German). | |
| ExportLogic | [0,1] | No | 0 | EXPERIMENTAL. This is an experimental feature and subject to change without notice. Default 0. If 1 it will export the logic. |
This request returns the name of the survey as well as some addition information
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the survey. | |
| Language | <String> | No | The language code for the language you want to export the survey in. If not specified it will use the default language. |
This request returns a list of all the surveys for the user.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. |
This request imports a survey using the TXT or JSON format. The API assumes the file data was submitted in the POST. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ImportFormat | {TXT, QSF, DOC, MSQ} | No | TXT | The format of the import. |
| Name | <String> | Yes | The survey name. | |
| Activate | [0,1] | No | 0 | If FALSE (0) will be created in an Inactive state. If TRUE (1) will be created in an active state. |
| URL | <URL> | No | If present it will import the file from the given URL. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| OwnerID | <String> | No | UserID of caller | Specify the owner of this survey (a valid UserID or BrandID, Division and Group owned surveys are deprecated). Default owner is the user making this call. |
This request imports a set of survey translations using the CSV or XML format. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the Survey for which we are updating translations. | |
| URL | <URL> | No | If present it will import the file from the given URL. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| AsAdmin | [0,1] | No | TRUE if making this call on behalf of a survey that is owned by someone else in your org (As an Admin) |
Sets the survey options.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The survey options to be changed. | |
| Active | [0,1] | No | Activates or Deactivates the survey if specified. | |
| CloseSessions | [0,1] | No | 1 | When Active=0 this can be used to close all active sessions. |
| Expiration | [0,1] | No | Allows the survey to expire. The survey will only be valid between ExpirationStartDate and ExpirationEndDate. | |
| ExpirationStartDate | YYYY-MM-DD hh:mm:ss | No | When Expiration=1 the first date the survey will be valid. | |
| ExpirationEndDate | YYYY-MM-DD hh:mm:ss | No | When Expiration=1 the last date day the survey will be valid. | |
| SourceTimeZone | <String> | No |
This request transfers survey ownership to the specified user
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the Survey to change ownership | |
| SurveyName | <String> | No | The new name of the survey, if left empty will keep the current name | |
| OwnerID | <String> | Yes | The original owner of the survey | |
| NewOwnerID | <String> | Yes | The user that will receive ownership |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to activate. |
This request adds a person to a 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| PersonID | <String> | Yes | The Person ID | |
| ThreeSixtyID | <String> | Yes | The 360 you will be adding the person to. | |
| External | [0,1] | No | 0 | Denotes whether a person is external to the 360 (1 == external). Defaults to 0 if not present. For EE projects always set external = 1. |
| ForceUpdate | [0,1] | No | 0 | If the person is already in the assessment, this forces an update of the externality of the person specified. Defaults to 0 (just skip). |
Closes a specified 360 assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to close. | |
| CloseSessions | [0,1] | No | 1 | Whether to close partial form sessions or not. |
| DeleteMailings | [0,1] | No | 1 | Whether to delete any scheduled mailings. |
| ReadyReports | [0,1] | No | 1 | Whether to ready the reports or not. |
This request creates a new person in the provided Organization Structure
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| <String> | Yes | The email for the new person, will also be the username | ||
| FirstName | <String> | Yes | The first name of the new person. | |
| LastName | <String> | Yes | The last name for the new person. | |
| UserName | <String> | No | Optionally specify the username of the person you are creating. Defaults to the email. | |
| OrgStructureID | <String> | No | The organization structure ID | |
| PersonID | <String> | No | The PersonID for the person to be created must be valid unused person GUID | |
| DivisionID | <String> | No | The division if wanted to place the new person/user in | |
| External | [0,1] | No | 0 | Is the person an external? 1== external, 0 == not external |
| MetaData | <String> | No | The custom MetaData for the new person passed as an array |
** DEPRECATED in 2.3. Use CreateAssessment instead.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | The name of the assessment. | |
| ThreeSixtyID | <String> | No | If supplied, will use this ID for the newly-created assessment. | |
| OwnerID | <String> | No | The owner of the assessment (User ID, Group ID or Division ID). | |
| SurveyID | <String> | No | If supplied, will associate this Form ID with this assessment, and not create a new form. | |
| WorkFlowOptions | <String> | No | Optional workflow options. | |
| Relationships | <String> | No | Optional relationships this assessment will use. | |
| NewAssessment | [0,1] | No | 0 | The type of Assessment to create. defaults to a classic threesixty (false) true creates a new Assessment |
This request deletes the specified assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you would like to delete. |
This request deletes the specified user.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| UserID | <String> | Yes | The ID of the user you would like to delete. |
This request returns the custom relationships for a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The 360 ID |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want the definition for. |
Returns a list of all the assessments for the users brand.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. |
Returns a CSV containing the Evaluation Status for the specified Assessment
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment for which you want the evaluation status. | |
| IncludeEvaluationResponses | [0,1] | No | 0 | Whether or not to include response data with the evaluations. |
| Questions | <String>%2C<String> | No | A comma separated list of Question IDs. Will filter the data to only include those specific questions, if IncludeEvaluationResponses is enabled. | |
| IncludeEvaluatorMetadata | [0,1] | No | 0 | Whether or not to include the metadata for the Evaluator on each row. |
| IncludeSubjectMetadata | [0,1] | No | 0 | Whether or not to include the metadata for the Subject on each row. |
This request returns all persons in the organization
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | No | The organization structure ID | |
| IncludeMetaData | [0,1] | No | 0 | If 1, includes metadata for each person |
| StartIndex | <String> | No | 0 | The start index |
| RecordLimit | <String> | No | The maximum number of records to return. Defaults to unlimited. |
This request returns the persons in the organization below the specified person
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | Yes | The organization structure ID | |
| PersonID | <String> | Yes | Everyone below this person |
Returns a CSV containing the Response Status for the specified Pulse
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 1.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the project for which you want the response status. | |
| PulseID | <String> | Yes | The ID of the pulse for which you want the response status. | |
| Questions | <String>%2C<String> | No | A comma separated list of Question IDs. Will filter the data to only include those specific questions, if IncludeEvaluationResponses is enabled. |
This request returns a PDF of the specified person’s subject report for a given 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID | |
| PersonID | <String> | Yes | The subject of the report | |
| Viewer | <String> | No | Subject | The viewer of the report -- either a Person ID of the viewer, Admin or Subject. If a Person ID, will use that person as the viewer. If Admin, the viewer will be the person making this API call. If Subject, the viewer is the Subject PersonID specified above. |
This request returns a specified person’s subject report data for a given 360 Assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID | |
| PersonID | <String> | Yes | The subject of the report |
This request returns the export of all the subjects' status for a given 360 Assessment. Currently only CSV output format is supported.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The format the data will be transmitted in. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID |
This request imports a CSV list of persons (in batch) into the specified organization. The CSV file can be posted (there is an approximate 8 megabytes limit) or a URL can be given to retrieve the file from a remote server. The CSV file must contain a header row and be comma separated using “ for encapsulation
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | No | The organization structure ID to import the persons into. Leave blank if using ThreeSixtyID (uses the org structure ID of the assessment) | |
| ThreeSixtyID | <String> | No | The 360 you will be importing the persons into as subjects. Leave blank if you do not want them to be added as subjects | |
| URL | <String> | No | If present it will attempt to load the CSV file from the URL specified, otherwise it simply looks at the post for the data | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| Type | <String> | No | Directory | Import Type. Possible values include: Directory, Subjects or Evaluators (for 360 Projects), or Participants (for EE Projects) |
| CleanImport | [0,1] | No | If true, will remove any individuals that were not imported | |
| ClearRelationships | [0,1] | No | If true, will remove all relationships from the specified org structure before import | |
| UpdateResponses | [0,1] | No | If true, will update any responses given by the updated individuals with the metadata uploaded | |
| UseUniquePersonID | [0,1] | No | If true, will update any persons based on looking them up via the unique person id specified for the organization. If false, uses Email as the unique field. This is the only way to update email addresses and corresponding usernames. | |
| NoHierarchyUpdate | [0,1] | No | 0 | If true, will not update the people in the org hierarchies for the assessment |
This request removes a person from a 360 assessment or directory. If only a ThreeSixtyID is specified, this call removes the person from the 360 assessment. If only an Org Structure ID is specified, this call removes the person from the organization directory only.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| PersonID | <String> | Yes | The PersonID for the person to be removed | |
| ThreeSixtyID | <String> | No | The 360 (TS_) assessment in which you will be removing the person | |
| OrgStructureID | <String> | No | The Org Structure (OS_) directory in which you will be removing the person | |
| RemoveEvaluations | [0,1] | No | 0 | Remove Evaluations Given By This Person? 1 == yes, 0 == no. Default is no |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to reopen. |
This request resets a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Three Sixty to reset | |
| Cache | [0,1] | No | 0 | Clear the ThreeSixty Cache |
| Nominations | [0,1] | No | 0 | Remove all Nominations from 360 |
| Evaluations | [0,1] | No | 0 | Remove all Evaluations from 360 |
| Previews | [0,1] | No | 0 | Deletes and removes all preview survey responses from 360 |
| Participants | [0,1] | No | 0 | Remove all Participants from 360 |
| ReSync | [0,1] | No | 0 | Recalculate values and evaluations requirements |
This request sets custom relationships for a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The 360 ID | |
| jsonOfRelationships | <String> | No | The json of the custom relationships and their translations. Example:{"RL_0V8w4Pv4aBHG13n":{"EN":"Friend","ES":"Amigo "},"RL_23GpWwksHAZ053T":{"EN":"Enemy","ES":" Enemigo "},"RL_6sxXjX7aTPpvQ5n":{"EN":"Cohort","ES":" Cohorte"}}) |
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 RequestTo make a request to the API you need both a root URL and some basic parameters.Root URLThe root URL for communicating with the Qualtrics system is: https://yourdatacenterid.qualtrics.com/WRAPI/ThreeSixty/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.ParametersThe 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/ThreeSixty/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/ThreeSixty/api.php?Request=getLegacyResponseData&Format=XML Content-Type: application/json Request Body: {"User":"apiuser","Token":"lksjdfJdJklajdf3asdae3","SurveyID":"SV_123456789"}Required ParametersThe 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. |
| 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. |
| 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. |
The API uses a token based authentication system. This prevents you from needing to give out your password to third parties. Qualtrics needs both your user name and your token to authenticate your request. A request will be authenticated if a valid user name and token pair are passed as the 'User' and 'Token' parameters. Each Qualtrics user account can have one and only one token associated with it. The token never expires and can be regenerated at any time. To generate/regenerate your token:
This request activates an Orginization (Brand).
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | Yes | The Orginization ID |
Changes the user name from the old to the new user name
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OldUserName | <String> | Yes | The user name to be changed | |
| NewUserName | <String> | Yes | The new user name | |
| UserNameIsEmail | [0,1] | No | 1 | Default is 1. If 1 the user name must be an email address and the user’s email address will be updated in the system. It is strongly recommended to use email addresses as the user name. |
This request creates a new Division for a given Organization
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| DivisionID | <String> | No | If specified, will use this DivisionID | |
| Name | <String> | Yes | The name of this Division | |
| DivisionAdmins | <String> | No | The UserIDs of the desired Division Admins, passed as an array |
Create a new user
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| NewUsername | <String> | Yes | The name of the new user | |
| NewPassword | <String> | Yes | Password of new user | |
| FirstName | <String> | Yes | User’s first name | |
| LastName | <String> | Yes | User’s last name | |
| <String> | Yes | User’s email | ||
| Organization | <String> | Yes | Organization ID (Brand ID) | |
| Type | <String> | Yes | User Type | |
| DivisionID | <String> | No | Division ID |
This request deactivates an Orginization (Brand).
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | Yes | The Orginization ID |
Allows a 3rd party to check the status of all their subscriptions.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. |
Allows a 3rd party to check the status of a subscription.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber |
Gets all the User IDs for a Brand and/or Division To use this you must be the organization administrator or higher.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Organization | <String> | No | Specifies the Organization ID from which to obtain the User IDs. | |
| Division | <String> | No | (Optional) Specifies the Division ID from which to filter the User IDs. | |
| Offset | <String> | No | The index from which to begin the search. (Requires that a limit is provided as well) | |
| Limit | <String> | No | The maximum number of users to return. | |
| IncludeUserStats | [0,1] | No | 0 | (Optional) Set to 1 to include additional details and usage stats, including: total number of surveys, number of active surveys, and last survey response date. Note that this can significantly increase response time for especially large brands |
Allows a 3rd party client to subscribe to Qualtrics events. Topic subscription can be a single event * (Ex: 'threesixty.created') or a wildcard list of events using the * (star) notation to denote 'everything' (Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics.) Qualtrics Events include (but are not limited to): controlpanel.activateSurvey
| Attribute | Type | Description |
|---|---|---|
| Status | String | Active or Inactive, the result will be 'Active' if successful. |
| SurveyID | GUID | The Survey ID of the survey that has been activated |
| Attribute | Type | Description |
|---|---|---|
| Status | String | Active or Inactive, the result will be 'Inactive' if successful. |
| SurveyID | GUID | The Survey ID of the survey that has been deactivated |
| Attribute | Type | Description |
|---|---|---|
| Status | String | The status will always be Compete if successful. |
| SurveyID | GUID | The Survey ID of the survey whose response has been completed. |
| ResponseID | GUID | The Response ID of the response that has been completed. |
| RecipientID | GUID | The Recipient ID of the response that has been completed. Will only be included if non-null |
| ResponseEventContext | String | Custom context that can be set via the ResponseEventContext embeded data. 50 character limit |
| Attribute | Type | Description |
|---|---|---|
| Status | String | The status will always be Partial if successful. |
| SurveyID | GUID | The Survey ID of the survey whose partial response has been saved. |
| ResponseID | GUID | The Response ID of the response that has been recorded. |
| RecipientID | GUID | The Recipient ID of the response that has been recorded. Will only be included if non-null |
| ResponseEventContext | String | Custom context that can be set via the ResponseEventContext embeded data. 50 character limit |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The 360 the nomination was created for |
| SubjectID | GUID | The PersonID of the one doing the nominating; the one that will be evaluated |
| EvaluatorID | GUID | The PersonID of the one being nominated that will perform the evaluation |
| EvaluatorEmail | String | The Email Address of the person that will perform the evaluation |
| Relationship | String | The Relationship of the nomination |
| EvaluationURL | String | The Link to perform the evaluation (Survey Engine Link) |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The 360 the nomination was removed for |
| SubjectID | GUID | The PersonID of the one doing the nominating; the one that was to be evaluated |
| EvaluatorID | GUID | The PersonID of the one being nominated that was to perform the evaluation |
| Relationship | String | The Relationship of the nomination |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the newly-created 360 |
| SurveyID | GUID | The ID of associated survey |
| Workflow | JSON | The Workflow Settings |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the newly-created 360 |
| SubjectID | GUID | The PersonID of the person being evaluated |
| EvaluatorID | GUID | The PersonID of the one performing the evaluation |
| Status | String | The Status of the evaluation (Started, Finished) |
| SessionID | GUID | The SessionID of the initiated open survey session |
| ResponseID | GUID | (Optionally - When Finished) The ID of the Response |
| Relationship | String | The Relationship of the evaluation |
| Unsolicitied | Boolean | (Optionally - When Finished) Boolean TRUE if the response was unsolicited, FALSE otherwise |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| SubjectID | GUID | The PersonID of the subject of the report |
| ReportURL | String | The URL to view the report (Currently the link to log in to the Qualtrics Portal to view the report) |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| Status | String | Active or Inactive |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| SubjectID | GUID | The Person ID of the Subject |
| Status | String | Done or Waiting (Not Done) |
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber (we will make sure this is globally unique. All callers of this just need to ensure they are locally-unique.) | |
| PublicationURL | <URL> | Yes | The FULLY-Qualified URL to publish events to. For Example, if "http://mydomain.com/REST.php" it will publish messages to you via HTTP REST. The data pushed to the publication URL will be of Content-Type: application/x-www-urlencoded, NOT Content-Type: application/json | |
| Topics | <String> | Yes | String Value of Topics to subscribe to. Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics. | |
| Encrypt | [0,1] | No | 0 | If true, will encrypt the event messages using the supplied Shared Key. Encryption will be AES 128 or 256 depending on Shared Key length (16 bytes = 128 bit, 32 bytes = 256 bit). Encryption is not necessary if publishing to an https URL. * Encrypted MSG is Base64 encoded for transport purposes, therefore you must base64 decode the MSG before decrypting it. MSG plaintext will be in JSON format. |
| SharedKey | <String> | No | If specified, all event messages will be emitted with an HMAC using this key to guarantee message authenticity, and optionally encrypted using this key (if Encrypt = true). | |
| BrandID | <String> | No | If specified, subscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Allows a 3rd party client to unsubscribe to Qualtrics events. Any queued messages that have not been sent for that subscription will be deleted.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber | |
| BrandID | <String> | No | If specified, unsubscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Allows a 3rd party client to unsubscribe from all Qualtrics events.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | No | If specified, unsubscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Updates the specified User's information, based on UserID. To use this you must be the organization administrator or higher. For security reasons, you cannot set passwords for users other than yourself.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| UserID | <String> | Yes | ID of the user | |
| FirstName | <String> | No | First Name of user | |
| LastName | <String> | No | Last Name of user | |
| NewUsername | <String> | No | New Username of user | |
| NewPassword | <String> | No | New Password of user (can only set your own) | |
| <String> | No | New Email of user | ||
| Division | <String> | No | New Division ID of user | |
| UserType | <String> | No | New User Type | |
| Status | {Active, Disabled, NotVerified} | No | Updated Status for the user | |
| Permissions | <String> | No | JSON String representing the user permissions |
This request creates a new Message
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| Name | <String> | Yes | If specified, the name of the message | |
| Category | {InviteEmails, InactiveSurveyMessages, ReminderEmails, ThankYouEmails, EndOfSurveyMessages, GeneralMessages, ValidationMessages, LookAndFeelMessages, EmailSubject, SMSInvite, SMSReminder, SMSThankYou, TicketMessages} | Yes | The category of the new message | |
| Message | <String> | Yes | The text of the message to set; either an array mapping language codes to messages, or a single message to be set using the Language parameter | |
| Language | <String> | No | If specified, will set the translation in the specified language |
This request fetches the designated Message file
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| MessageID | <String> | Yes | The ID of the Message desired | |
| Language | <String> | No | If specified, will fetch the translation in the specified language (if available) |
Returns a list of library message ids.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message |
This request sets the designated Message text
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| MessageID | <String> | Yes | The ID of the Message desired | |
| Language | <String> | No | If specified, will set the translation in the specified language | |
| Message | <String> | Yes | The text of the message to set; either an array mapping language codes to messages, or a single message to be set using the Language parameter | |
| Name | <String> | No | If specified, will rename the message |
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ReportID | <String> | Yes | The Report ID for the report containing the Predefined Data Source.) | |
| DataSourceID | <String> | Yes | The Data Source ID for the Predefined Data Source to be updated. | |
| PredefinedData | <String> | No | A string of JSON-encoded predefined data to update the data source with | |
| URL | <URL> | No | The URL of an JSON file containing the new Data Source data |
Returns all of the response data for a survey in the original (legacy) data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, CSV, HTML, JSON} | Yes | The format the data will be transmitted in. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The survey you will be getting the responses for. | |
| LastResponseID | <String> | No | Each response is recorded sequentially. When specified it will export all responses after the id specified. | |
| Limit | <String> | No | The maximum number of responses to return. | |
| Offset | <String> | No | The starting index (inclusive) from which the responses will be retrieved. Combine with Limit to acheive pagination for responses in progress only. | |
| ResponseID | <String> | No | The response id of an individual response. ResponseSetID, SubgroupID, StartDate, and EndDate should not be specified when using this parameter. | |
| ResponseSetID | <String> | No | The response set you want to retrieve the data from. If not specified it will use the default response set. | |
| SubgroupID | <String> | No | The subgroup you want to download the data for. | |
| StartDate | YYYY-MM-DD hh:mm:ss | No | The date the responses must be after. | |
| EndDate | YYYY-MM-DD hh:mm:ss | No | The date the responses must be before. | |
| Questions | <String>%2C<String> | No | A comma separated list of question ids. Will filter the data to only include those specific questions. | |
| Labels | [0,1] | No | 0 | If 1 (true) the label for choices and answers will be used and not the id. The default is 0. |
| ExportTags | [0,1] | No | 0 | If 1 (true) the export tags will be used rather than the V labels. The default is 0. |
| ExportQuestionIDs | [0,1] | No | 0 | If 1 (true) the internal question IDs will be used rather than export tags or the V labels. The default is 0. |
| LocalTime | [0,1] | No | 1 | If 1 {true} the StartDate and EndDate will be exported using the specified user’s local time zone. |
| UnansweredRecode | <String> | No | The recode value for seen but unanswered questions. If not specified a blank value is put in for these questions. | |
| PanelID | <String> | No | If supplied it will only get the results for members of that specific panel. | |
| ResponsesInProgress | [0,1] | No | 0 | If 1 (true), will retrieve the responses in progress (and only the responses in progress). |
| LocationData | [0,1] | No | 0 | If 1 (true), will export location data. |
This request imports responses into the specified Employee Insights project. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format. The expected format of the file contents is the same format as the 'Evaluation Status' download with 'Include Response Data' checked.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the 360 into which we want to import responses. | |
| PulseID | <String> | No | The ID of the Pulse into which we want to import responses. | |
| URL | <URL> | No | If present it will import the file from the given url. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data |
Activates the specified Survey
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The Survey ID to activate |
Deactivates the specified Survey
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The Survey ID to deactivate |
Delete the specified survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | ID of the survey |
Gets all the quotas for a given survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | Survey ID of the survey in question. You must have permission to view responses on the given survey. |
Returns an HTML respresentation of the given response
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The response's associated survey ID | |
| ResponseID | <String> | Yes | The response to get HTML for | |
| ExcludeED | [0,1] | No | 0 | 1 to exclude embedded data. |
| ExcludeScoring | [0,1] | No | 0 | 1 to exclude scoring information. |
| ExcludeHiddenQuestions | [0,1] | No | 0 | 1 to exclude questions not displayed to the recipient. |
| ExcludeLocation | [0,1] | No | 0 | 1 to exclude location information. |
| IncludeHeader | [0,1] | No | 0 | 1 to include the header. |
This request returns an xml export of the survey. Version 2.2 includes an enhanced embedded data export.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Version | Version number like 'X.X' >= 2.2 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the survey whose xml definition will be retrieved. | |
| Language | <String> | No | The language code for the language you want to export the survey in. If not specified it will use the default language. Qualtrics generally adheres to the ISO 639-1 Standard for 2 character Language codes (http://en.wikipedia.org/wiki/ISO_639-1, ex. EN = English, ES = Spanish, DE = German). | |
| ExportLogic | [0,1] | No | 0 | EXPERIMENTAL. This is an experimental feature and subject to change without notice. Default 0. If 1 it will export the logic. |
This request returns the name of the survey as well as some addition information
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the survey. | |
| Language | <String> | No | The language code for the language you want to export the survey in. If not specified it will use the default language. |
This request returns a list of all the surveys for the user.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. |
This request imports a survey using the TXT or JSON format. The API assumes the file data was submitted in the POST. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ImportFormat | {TXT, QSF, DOC, MSQ} | No | TXT | The format of the import. |
| Name | <String> | Yes | The survey name. | |
| Activate | [0,1] | No | 0 | If FALSE (0) will be created in an Inactive state. If TRUE (1) will be created in an active state. |
| URL | <URL> | No | If present it will import the file from the given URL. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| OwnerID | <String> | No | UserID of caller | Specify the owner of this survey (a valid UserID or BrandID, Division and Group owned surveys are deprecated). Default owner is the user making this call. |
This request imports a set of survey translations using the CSV or XML format. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the Survey for which we are updating translations. | |
| URL | <URL> | No | If present it will import the file from the given URL. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| AsAdmin | [0,1] | No | TRUE if making this call on behalf of a survey that is owned by someone else in your org (As an Admin) |
Sets the survey options.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The survey options to be changed. | |
| Active | [0,1] | No | Activates or Deactivates the survey if specified. | |
| CloseSessions | [0,1] | No | 1 | When Active=0 this can be used to close all active sessions. |
| Expiration | [0,1] | No | Allows the survey to expire. The survey will only be valid between ExpirationStartDate and ExpirationEndDate. | |
| ExpirationStartDate | YYYY-MM-DD hh:mm:ss | No | When Expiration=1 the first date the survey will be valid. | |
| ExpirationEndDate | YYYY-MM-DD hh:mm:ss | No | When Expiration=1 the last date day the survey will be valid. | |
| SourceTimeZone | <String> | No |
This request transfers survey ownership to the specified user
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the Survey to change ownership | |
| SurveyName | <String> | No | The new name of the survey, if left empty will keep the current name | |
| OwnerID | <String> | Yes | The original owner of the survey | |
| NewOwnerID | <String> | Yes | The user that will receive ownership |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to activate. |
This request adds a person to a 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| PersonID | <String> | Yes | The Person ID | |
| ThreeSixtyID | <String> | Yes | The 360 you will be adding the person to. | |
| External | [0,1] | No | 0 | Denotes whether a person is external to the 360 (1 == external). Defaults to 0 if not present. For EE projects always set external = 1. |
| ForceUpdate | [0,1] | No | 0 | If the person is already in the assessment, this forces an update of the externality of the person specified. Defaults to 0 (just skip). |
Closes a specified 360 assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to close. | |
| CloseSessions | [0,1] | No | 1 | Whether to close partial form sessions or not. |
| DeleteMailings | [0,1] | No | 1 | Whether to delete any scheduled mailings. |
| ReadyReports | [0,1] | No | 1 | Whether to ready the reports or not. |
This request creates a new person in the provided Organization Structure
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| <String> | Yes | The email for the new person, will also be the username | ||
| FirstName | <String> | Yes | The first name of the new person. | |
| LastName | <String> | Yes | The last name for the new person. | |
| UserName | <String> | No | Optionally specify the username of the person you are creating. Defaults to the email. | |
| OrgStructureID | <String> | No | The organization structure ID | |
| PersonID | <String> | No | The PersonID for the person to be created must be valid unused person GUID | |
| DivisionID | <String> | No | The division if wanted to place the new person/user in | |
| External | [0,1] | No | 0 | Is the person an external? 1== external, 0 == not external |
| MetaData | <String> | No | The custom MetaData for the new person passed as an array |
** DEPRECATED in 2.3. Use CreateAssessment instead.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | The name of the assessment. | |
| ThreeSixtyID | <String> | No | If supplied, will use this ID for the newly-created assessment. | |
| OwnerID | <String> | No | The owner of the assessment (User ID, Group ID or Division ID). | |
| SurveyID | <String> | No | If supplied, will associate this Form ID with this assessment, and not create a new form. | |
| WorkFlowOptions | <String> | No | Optional workflow options. | |
| Relationships | <String> | No | Optional relationships this assessment will use. | |
| NewAssessment | [0,1] | No | 0 | The type of Assessment to create. defaults to a classic threesixty (false) true creates a new Assessment |
This request deletes the specified assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you would like to delete. |
This request deletes the specified user.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| UserID | <String> | Yes | The ID of the user you would like to delete. |
This request returns the custom relationships for a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The 360 ID |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want the definition for. |
Returns a list of all the assessments for the users brand.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. |
Returns a CSV containing the Evaluation Status for the specified Assessment
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment for which you want the evaluation status. | |
| IncludeEvaluationResponses | [0,1] | No | 0 | Whether or not to include response data with the evaluations. |
| Questions | <String>%2C<String> | No | A comma separated list of Question IDs. Will filter the data to only include those specific questions, if IncludeEvaluationResponses is enabled. | |
| IncludeEvaluatorMetadata | [0,1] | No | 0 | Whether or not to include the metadata for the Evaluator on each row. |
| IncludeSubjectMetadata | [0,1] | No | 0 | Whether or not to include the metadata for the Subject on each row. |
This request returns all persons in the organization
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | No | The organization structure ID | |
| IncludeMetaData | [0,1] | No | 0 | If 1, includes metadata for each person |
| StartIndex | <String> | No | 0 | The start index |
| RecordLimit | <String> | No | The maximum number of records to return. Defaults to unlimited. |
This request returns the persons in the organization below the specified person
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | Yes | The organization structure ID | |
| PersonID | <String> | Yes | Everyone below this person |
Returns a CSV containing the Response Status for the specified Pulse
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 1.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the project for which you want the response status. | |
| PulseID | <String> | Yes | The ID of the pulse for which you want the response status. | |
| Questions | <String>%2C<String> | No | A comma separated list of Question IDs. Will filter the data to only include those specific questions, if IncludeEvaluationResponses is enabled. |
This request returns a PDF of the specified person’s subject report for a given 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID | |
| PersonID | <String> | Yes | The subject of the report | |
| Viewer | <String> | No | Subject | The viewer of the report -- either a Person ID of the viewer, Admin or Subject. If a Person ID, will use that person as the viewer. If Admin, the viewer will be the person making this API call. If Subject, the viewer is the Subject PersonID specified above. |
This request returns a specified person’s subject report data for a given 360 Assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID | |
| PersonID | <String> | Yes | The subject of the report |
This request returns the export of all the subjects' status for a given 360 Assessment. Currently only CSV output format is supported.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The format the data will be transmitted in. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID |
This request imports a CSV list of persons (in batch) into the specified organization. The CSV file can be posted (there is an approximate 8 megabytes limit) or a URL can be given to retrieve the file from a remote server. The CSV file must contain a header row and be comma separated using “ for encapsulation
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | No | The organization structure ID to import the persons into. Leave blank if using ThreeSixtyID (uses the org structure ID of the assessment) | |
| ThreeSixtyID | <String> | No | The 360 you will be importing the persons into as subjects. Leave blank if you do not want them to be added as subjects | |
| URL | <String> | No | If present it will attempt to load the CSV file from the URL specified, otherwise it simply looks at the post for the data | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| Type | <String> | No | Directory | Import Type. Possible values include: Directory, Subjects or Evaluators (for 360 Projects), or Participants (for EE Projects) |
| CleanImport | [0,1] | No | If true, will remove any individuals that were not imported | |
| ClearRelationships | [0,1] | No | If true, will remove all relationships from the specified org structure before import | |
| UpdateResponses | [0,1] | No | If true, will update any responses given by the updated individuals with the metadata uploaded | |
| UseUniquePersonID | [0,1] | No | If true, will update any persons based on looking them up via the unique person id specified for the organization. If false, uses Email as the unique field. This is the only way to update email addresses and corresponding usernames. | |
| NoHierarchyUpdate | [0,1] | No | 0 | If true, will not update the people in the org hierarchies for the assessment |
This request removes a person from a 360 assessment or directory. If only a ThreeSixtyID is specified, this call removes the person from the 360 assessment. If only an Org Structure ID is specified, this call removes the person from the organization directory only.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| PersonID | <String> | Yes | The PersonID for the person to be removed | |
| ThreeSixtyID | <String> | No | The 360 (TS_) assessment in which you will be removing the person | |
| OrgStructureID | <String> | No | The Org Structure (OS_) directory in which you will be removing the person | |
| RemoveEvaluations | [0,1] | No | 0 | Remove Evaluations Given By This Person? 1 == yes, 0 == no. Default is no |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to reopen. |
This request resets a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Three Sixty to reset | |
| Cache | [0,1] | No | 0 | Clear the ThreeSixty Cache |
| Nominations | [0,1] | No | 0 | Remove all Nominations from 360 |
| Evaluations | [0,1] | No | 0 | Remove all Evaluations from 360 |
| Previews | [0,1] | No | 0 | Deletes and removes all preview survey responses from 360 |
| Participants | [0,1] | No | 0 | Remove all Participants from 360 |
| ReSync | [0,1] | No | 0 | Recalculate values and evaluations requirements |
This request sets custom relationships for a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The 360 ID | |
| jsonOfRelationships | <String> | No | The json of the custom relationships and their translations. Example:{"RL_0V8w4Pv4aBHG13n":{"EN":"Friend","ES":"Amigo "},"RL_23GpWwksHAZ053T":{"EN":"Enemy","ES":" Enemigo "},"RL_6sxXjX7aTPpvQ5n":{"EN":"Cohort","ES":" Cohorte"}}) |
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 RequestTo make a request to the API you need both a root URL and some basic parameters.Root URLThe root URL for communicating with the Qualtrics system is: https://yourdatacenterid.qualtrics.com/WRAPI/ThreeSixty/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.ParametersThe 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/ThreeSixty/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/ThreeSixty/api.php?Request=getLegacyResponseData&Format=XML Content-Type: application/json Request Body: {"User":"apiuser","Token":"lksjdfJdJklajdf3asdae3","SurveyID":"SV_123456789"}Required ParametersThe 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. |
| 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. |
| 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. |
The API uses a token based authentication system. This prevents you from needing to give out your password to third parties. Qualtrics needs both your user name and your token to authenticate your request. A request will be authenticated if a valid user name and token pair are passed as the 'User' and 'Token' parameters. Each Qualtrics user account can have one and only one token associated with it. The token never expires and can be regenerated at any time. To generate/regenerate your token:
This request activates an Orginization (Brand).
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | Yes | The Orginization ID |
Changes the user name from the old to the new user name
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OldUserName | <String> | Yes | The user name to be changed | |
| NewUserName | <String> | Yes | The new user name | |
| UserNameIsEmail | [0,1] | No | 1 | Default is 1. If 1 the user name must be an email address and the user’s email address will be updated in the system. It is strongly recommended to use email addresses as the user name. |
This request creates a new Division for a given Organization
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| DivisionID | <String> | No | If specified, will use this DivisionID | |
| Name | <String> | Yes | The name of this Division | |
| DivisionAdmins | <String> | No | The UserIDs of the desired Division Admins, passed as an array |
Create a new user
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| NewUsername | <String> | Yes | The name of the new user | |
| NewPassword | <String> | Yes | Password of new user | |
| FirstName | <String> | Yes | User’s first name | |
| LastName | <String> | Yes | User’s last name | |
| <String> | Yes | User’s email | ||
| Organization | <String> | Yes | Organization ID (Brand ID) | |
| Type | <String> | Yes | User Type | |
| DivisionID | <String> | No | Division ID |
This request deactivates an Orginization (Brand).
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | Yes | The Orginization ID |
Allows a 3rd party to check the status of all their subscriptions.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. |
Allows a 3rd party to check the status of a subscription.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber |
Gets all the User IDs for a Brand and/or Division To use this you must be the organization administrator or higher.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Organization | <String> | No | Specifies the Organization ID from which to obtain the User IDs. | |
| Division | <String> | No | (Optional) Specifies the Division ID from which to filter the User IDs. | |
| Offset | <String> | No | The index from which to begin the search. (Requires that a limit is provided as well) | |
| Limit | <String> | No | The maximum number of users to return. | |
| IncludeUserStats | [0,1] | No | 0 | (Optional) Set to 1 to include additional details and usage stats, including: total number of surveys, number of active surveys, and last survey response date. Note that this can significantly increase response time for especially large brands |
Allows a 3rd party client to subscribe to Qualtrics events. Topic subscription can be a single event * (Ex: 'threesixty.created') or a wildcard list of events using the * (star) notation to denote 'everything' (Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics.) Qualtrics Events include (but are not limited to): controlpanel.activateSurvey
| Attribute | Type | Description |
|---|---|---|
| Status | String | Active or Inactive, the result will be 'Active' if successful. |
| SurveyID | GUID | The Survey ID of the survey that has been activated |
| Attribute | Type | Description |
|---|---|---|
| Status | String | Active or Inactive, the result will be 'Inactive' if successful. |
| SurveyID | GUID | The Survey ID of the survey that has been deactivated |
| Attribute | Type | Description |
|---|---|---|
| Status | String | The status will always be Compete if successful. |
| SurveyID | GUID | The Survey ID of the survey whose response has been completed. |
| ResponseID | GUID | The Response ID of the response that has been completed. |
| RecipientID | GUID | The Recipient ID of the response that has been completed. Will only be included if non-null |
| ResponseEventContext | String | Custom context that can be set via the ResponseEventContext embeded data. 50 character limit |
| Attribute | Type | Description |
|---|---|---|
| Status | String | The status will always be Partial if successful. |
| SurveyID | GUID | The Survey ID of the survey whose partial response has been saved. |
| ResponseID | GUID | The Response ID of the response that has been recorded. |
| RecipientID | GUID | The Recipient ID of the response that has been recorded. Will only be included if non-null |
| ResponseEventContext | String | Custom context that can be set via the ResponseEventContext embeded data. 50 character limit |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The 360 the nomination was created for |
| SubjectID | GUID | The PersonID of the one doing the nominating; the one that will be evaluated |
| EvaluatorID | GUID | The PersonID of the one being nominated that will perform the evaluation |
| EvaluatorEmail | String | The Email Address of the person that will perform the evaluation |
| Relationship | String | The Relationship of the nomination |
| EvaluationURL | String | The Link to perform the evaluation (Survey Engine Link) |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The 360 the nomination was removed for |
| SubjectID | GUID | The PersonID of the one doing the nominating; the one that was to be evaluated |
| EvaluatorID | GUID | The PersonID of the one being nominated that was to perform the evaluation |
| Relationship | String | The Relationship of the nomination |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the newly-created 360 |
| SurveyID | GUID | The ID of associated survey |
| Workflow | JSON | The Workflow Settings |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the newly-created 360 |
| SubjectID | GUID | The PersonID of the person being evaluated |
| EvaluatorID | GUID | The PersonID of the one performing the evaluation |
| Status | String | The Status of the evaluation (Started, Finished) |
| SessionID | GUID | The SessionID of the initiated open survey session |
| ResponseID | GUID | (Optionally - When Finished) The ID of the Response |
| Relationship | String | The Relationship of the evaluation |
| Unsolicitied | Boolean | (Optionally - When Finished) Boolean TRUE if the response was unsolicited, FALSE otherwise |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| SubjectID | GUID | The PersonID of the subject of the report |
| ReportURL | String | The URL to view the report (Currently the link to log in to the Qualtrics Portal to view the report) |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| Status | String | Active or Inactive |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| SubjectID | GUID | The Person ID of the Subject |
| Status | String | Done or Waiting (Not Done) |
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber (we will make sure this is globally unique. All callers of this just need to ensure they are locally-unique.) | |
| PublicationURL | <URL> | Yes | The FULLY-Qualified URL to publish events to. For Example, if "http://mydomain.com/REST.php" it will publish messages to you via HTTP REST. The data pushed to the publication URL will be of Content-Type: application/x-www-urlencoded, NOT Content-Type: application/json | |
| Topics | <String> | Yes | String Value of Topics to subscribe to. Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics. | |
| Encrypt | [0,1] | No | 0 | If true, will encrypt the event messages using the supplied Shared Key. Encryption will be AES 128 or 256 depending on Shared Key length (16 bytes = 128 bit, 32 bytes = 256 bit). Encryption is not necessary if publishing to an https URL. * Encrypted MSG is Base64 encoded for transport purposes, therefore you must base64 decode the MSG before decrypting it. MSG plaintext will be in JSON format. |
| SharedKey | <String> | No | If specified, all event messages will be emitted with an HMAC using this key to guarantee message authenticity, and optionally encrypted using this key (if Encrypt = true). | |
| BrandID | <String> | No | If specified, subscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Allows a 3rd party client to unsubscribe to Qualtrics events. Any queued messages that have not been sent for that subscription will be deleted.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber | |
| BrandID | <String> | No | If specified, unsubscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Allows a 3rd party client to unsubscribe from all Qualtrics events.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | No | If specified, unsubscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Updates the specified User's information, based on UserID. To use this you must be the organization administrator or higher. For security reasons, you cannot set passwords for users other than yourself.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| UserID | <String> | Yes | ID of the user | |
| FirstName | <String> | No | First Name of user | |
| LastName | <String> | No | Last Name of user | |
| NewUsername | <String> | No | New Username of user | |
| NewPassword | <String> | No | New Password of user (can only set your own) | |
| <String> | No | New Email of user | ||
| Division | <String> | No | New Division ID of user | |
| UserType | <String> | No | New User Type | |
| Status | {Active, Disabled, NotVerified} | No | Updated Status for the user | |
| Permissions | <String> | No | JSON String representing the user permissions |
This request creates a new Message
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| Name | <String> | Yes | If specified, the name of the message | |
| Category | {InviteEmails, InactiveSurveyMessages, ReminderEmails, ThankYouEmails, EndOfSurveyMessages, GeneralMessages, ValidationMessages, LookAndFeelMessages, EmailSubject, SMSInvite, SMSReminder, SMSThankYou, TicketMessages} | Yes | The category of the new message | |
| Message | <String> | Yes | The text of the message to set; either an array mapping language codes to messages, or a single message to be set using the Language parameter | |
| Language | <String> | No | If specified, will set the translation in the specified language |
This request fetches the designated Message file
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| MessageID | <String> | Yes | The ID of the Message desired | |
| Language | <String> | No | If specified, will fetch the translation in the specified language (if available) |
Returns a list of library message ids.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message |
This request sets the designated Message text
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| MessageID | <String> | Yes | The ID of the Message desired | |
| Language | <String> | No | If specified, will set the translation in the specified language | |
| Message | <String> | Yes | The text of the message to set; either an array mapping language codes to messages, or a single message to be set using the Language parameter | |
| Name | <String> | No | If specified, will rename the message |
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ReportID | <String> | Yes | The Report ID for the report containing the Predefined Data Source.) | |
| DataSourceID | <String> | Yes | The Data Source ID for the Predefined Data Source to be updated. | |
| PredefinedData | <String> | No | A string of JSON-encoded predefined data to update the data source with | |
| URL | <URL> | No | The URL of an JSON file containing the new Data Source data |
Returns all of the response data for a survey in the original (legacy) data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, CSV, HTML, JSON} | Yes | The format the data will be transmitted in. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The survey you will be getting the responses for. | |
| LastResponseID | <String> | No | Each response is recorded sequentially. When specified it will export all responses after the id specified. | |
| Limit | <String> | No | The maximum number of responses to return. | |
| Offset | <String> | No | The starting index (inclusive) from which the responses will be retrieved. Combine with Limit to acheive pagination for responses in progress only. | |
| ResponseID | <String> | No | The response id of an individual response. ResponseSetID, SubgroupID, StartDate, and EndDate should not be specified when using this parameter. | |
| ResponseSetID | <String> | No | The response set you want to retrieve the data from. If not specified it will use the default response set. | |
| SubgroupID | <String> | No | The subgroup you want to download the data for. | |
| StartDate | YYYY-MM-DD hh:mm:ss | No | The date the responses must be after. | |
| EndDate | YYYY-MM-DD hh:mm:ss | No | The date the responses must be before. | |
| Questions | <String>%2C<String> | No | A comma separated list of question ids. Will filter the data to only include those specific questions. | |
| Labels | [0,1] | No | 0 | If 1 (true) the label for choices and answers will be used and not the id. The default is 0. |
| ExportTags | [0,1] | No | 0 | If 1 (true) the export tags will be used rather than the V labels. The default is 0. |
| ExportQuestionIDs | [0,1] | No | 0 | If 1 (true) the internal question IDs will be used rather than export tags or the V labels. The default is 0. |
| LocalTime | [0,1] | No | 1 | If 1 {true} the StartDate and EndDate will be exported using the specified user’s local time zone. |
| UnansweredRecode | <String> | No | The recode value for seen but unanswered questions. If not specified a blank value is put in for these questions. | |
| PanelID | <String> | No | If supplied it will only get the results for members of that specific panel. | |
| ResponsesInProgress | [0,1] | No | 0 | If 1 (true), will retrieve the responses in progress (and only the responses in progress). |
| LocationData | [0,1] | No | 0 | If 1 (true), will export location data. |
This request imports responses into the specified Employee Insights project. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format. The expected format of the file contents is the same format as the 'Evaluation Status' download with 'Include Response Data' checked.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the 360 into which we want to import responses. | |
| PulseID | <String> | No | The ID of the Pulse into which we want to import responses. | |
| URL | <URL> | No | If present it will import the file from the given url. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data |
Activates the specified Survey
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The Survey ID to activate |
Deactivates the specified Survey
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The Survey ID to deactivate |
Delete the specified survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | ID of the survey |
Gets all the quotas for a given survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | Survey ID of the survey in question. You must have permission to view responses on the given survey. |
Returns an HTML respresentation of the given response
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The response's associated survey ID | |
| ResponseID | <String> | Yes | The response to get HTML for | |
| ExcludeED | [0,1] | No | 0 | 1 to exclude embedded data. |
| ExcludeScoring | [0,1] | No | 0 | 1 to exclude scoring information. |
| ExcludeHiddenQuestions | [0,1] | No | 0 | 1 to exclude questions not displayed to the recipient. |
| ExcludeLocation | [0,1] | No | 0 | 1 to exclude location information. |
| IncludeHeader | [0,1] | No | 0 | 1 to include the header. |
This request returns an xml export of the survey. Version 2.3 includes an enhanced embedded data export, compound questions, and extended validation information. Additionally, choices are no longer ordered by choiceID, but rather by the order they appear in the survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Version | Version number like 'X.X' >= 2.3 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the survey whose xml definition will be retrieved. | |
| Language | <String> | No | The language code for the language you want to export the survey in. If not specified it will use the default language. Qualtrics generally adheres to the ISO 639-1 Standard for 2 character Language codes (http://en.wikipedia.org/wiki/ISO_639-1, ex. EN = English, ES = Spanish, DE = German). | |
| ExportLogic | [0,1] | No | 0 | EXPERIMENTAL. This is an experimental feature and subject to change without notice. Default 0. If 1 it will export the logic. |
This request returns the name of the survey as well as some addition information
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the survey. | |
| Language | <String> | No | The language code for the language you want to export the survey in. If not specified it will use the default language. |
This request returns a list of all the surveys for the user.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. |
This request imports a survey using the TXT or JSON format. The API assumes the file data was submitted in the POST. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ImportFormat | {TXT, QSF, DOC, MSQ} | No | TXT | The format of the import. |
| Name | <String> | Yes | The survey name. | |
| Activate | [0,1] | No | 0 | If FALSE (0) will be created in an Inactive state. If TRUE (1) will be created in an active state. |
| URL | <URL> | No | If present it will import the file from the given URL. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| OwnerID | <String> | No | UserID of caller | Specify the owner of this survey (a valid UserID or BrandID, Division and Group owned surveys are deprecated). Default owner is the user making this call. |
This request imports a set of survey translations using the CSV or XML format. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the Survey for which we are updating translations. | |
| URL | <URL> | No | If present it will import the file from the given URL. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| AsAdmin | [0,1] | No | TRUE if making this call on behalf of a survey that is owned by someone else in your org (As an Admin) |
Sets the survey options.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The survey options to be changed. | |
| Active | [0,1] | No | Activates or Deactivates the survey if specified. | |
| CloseSessions | [0,1] | No | 1 | When Active=0 this can be used to close all active sessions. |
| Expiration | [0,1] | No | Allows the survey to expire. The survey will only be valid between ExpirationStartDate and ExpirationEndDate. | |
| ExpirationStartDate | YYYY-MM-DD hh:mm:ss | No | When Expiration=1 the first date the survey will be valid. | |
| ExpirationEndDate | YYYY-MM-DD hh:mm:ss | No | When Expiration=1 the last date day the survey will be valid. | |
| SourceTimeZone | <String> | No |
This request transfers survey ownership to the specified user
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the Survey to change ownership | |
| SurveyName | <String> | No | The new name of the survey, if left empty will keep the current name | |
| OwnerID | <String> | Yes | The original owner of the survey | |
| NewOwnerID | <String> | Yes | The user that will receive ownership |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to activate. |
This request adds a person to a 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| PersonID | <String> | Yes | The Person ID | |
| ThreeSixtyID | <String> | Yes | The 360 you will be adding the person to. | |
| External | [0,1] | No | 0 | Denotes whether a person is external to the 360 (1 == external). Defaults to 0 if not present. For EE projects always set external = 1. |
| ForceUpdate | [0,1] | No | 0 | If the person is already in the assessment, this forces an update of the externality of the person specified. Defaults to 0 (just skip). |
Closes a specified 360 assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to close. | |
| CloseSessions | [0,1] | No | 1 | Whether to close partial form sessions or not. |
| DeleteMailings | [0,1] | No | 1 | Whether to delete any scheduled mailings. |
| ReadyReports | [0,1] | No | 1 | Whether to ready the reports or not. |
Creates an Assessment
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.3 | Yes | The version of the API to use. | |
| Name | <String> | Yes | The name of the assessment. | |
| ThreeSixtyID | <String> | No | If supplied, will use this ID for the newly-created assessment. | |
| OwnerID | <String> | No | The owner of the assessment (User ID, Group ID, Division ID or Brand ID). Assessment is made public to the entire organization if owner is set to the Brand ID. | |
| SurveyID | <String> | No | If supplied, will associate this Form ID with this assessment, and not create a new form. | |
| WorkFlowOptions | <String> | No | Optional workflow options. | |
| Relationships | <String> | No | Optional relationships this assessment will use. | |
| Type | <String> | No | 360 | The type of Assessment to create. default=360. Options are 360, EE or EmployeePulse |
This request creates a new person in the provided Organization Structure
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| <String> | Yes | The email for the new person, will also be the username | ||
| FirstName | <String> | Yes | The first name of the new person. | |
| LastName | <String> | Yes | The last name for the new person. | |
| UserName | <String> | No | Optionally specify the username of the person you are creating. Defaults to the email. | |
| OrgStructureID | <String> | No | The organization structure ID | |
| PersonID | <String> | No | The PersonID for the person to be created must be valid unused person GUID | |
| DivisionID | <String> | No | The division if wanted to place the new person/user in | |
| External | [0,1] | No | 0 | Is the person an external? 1== external, 0 == not external |
| MetaData | <String> | No | The custom MetaData for the new person passed as an array |
** DEPRECATED in 2.3. Use CreateAssessment instead.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | The name of the assessment. | |
| ThreeSixtyID | <String> | No | If supplied, will use this ID for the newly-created assessment. | |
| OwnerID | <String> | No | The owner of the assessment (User ID, Group ID or Division ID). | |
| SurveyID | <String> | No | If supplied, will associate this Form ID with this assessment, and not create a new form. | |
| WorkFlowOptions | <String> | No | Optional workflow options. | |
| Relationships | <String> | No | Optional relationships this assessment will use. | |
| NewAssessment | [0,1] | No | 0 | The type of Assessment to create. defaults to a classic threesixty (false) true creates a new Assessment |
This request deletes the specified assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you would like to delete. |
This request deletes the specified user.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| UserID | <String> | Yes | The ID of the user you would like to delete. |
This request returns the custom relationships for a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The 360 ID |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want the definition for. |
Returns a list of all the assessments for the users brand.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. |
Returns a CSV containing the Evaluation Status for the specified Assessment
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment for which you want the evaluation status. | |
| IncludeEvaluationResponses | [0,1] | No | 0 | Whether or not to include response data with the evaluations. |
| Questions | <String>%2C<String> | No | A comma separated list of Question IDs. Will filter the data to only include those specific questions, if IncludeEvaluationResponses is enabled. | |
| IncludeEvaluatorMetadata | [0,1] | No | 0 | Whether or not to include the metadata for the Evaluator on each row. |
| IncludeSubjectMetadata | [0,1] | No | 0 | Whether or not to include the metadata for the Subject on each row. |
This request returns all persons in the organization
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | No | The organization structure ID | |
| IncludeMetaData | [0,1] | No | 0 | If 1, includes metadata for each person |
| StartIndex | <String> | No | 0 | The start index |
| RecordLimit | <String> | No | The maximum number of records to return. Defaults to unlimited. |
This request returns the persons in the organization below the specified person
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | Yes | The organization structure ID | |
| PersonID | <String> | Yes | Everyone below this person |
Returns a CSV containing the Response Status for the specified Pulse
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 1.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the project for which you want the response status. | |
| PulseID | <String> | Yes | The ID of the pulse for which you want the response status. | |
| Questions | <String>%2C<String> | No | A comma separated list of Question IDs. Will filter the data to only include those specific questions, if IncludeEvaluationResponses is enabled. |
This request returns a PDF of the specified person’s subject report for a given 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID | |
| PersonID | <String> | Yes | The subject of the report | |
| Viewer | <String> | No | Subject | The viewer of the report -- either a Person ID of the viewer, Admin or Subject. If a Person ID, will use that person as the viewer. If Admin, the viewer will be the person making this API call. If Subject, the viewer is the Subject PersonID specified above. |
This request returns a specified person’s subject report data for a given 360 Assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID | |
| PersonID | <String> | Yes | The subject of the report |
This request returns the export of all the subjects' status for a given 360 Assessment. Currently only CSV output format is supported.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The format the data will be transmitted in. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID |
This request imports a CSV list of persons (in batch) into the specified organization. The CSV file can be posted (there is an approximate 8 megabytes limit) or a URL can be given to retrieve the file from a remote server. The CSV file must contain a header row and be comma separated using “ for encapsulation
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | No | The organization structure ID to import the persons into. Leave blank if using ThreeSixtyID (uses the org structure ID of the assessment) | |
| ThreeSixtyID | <String> | No | The 360 you will be importing the persons into as subjects. Leave blank if you do not want them to be added as subjects | |
| URL | <String> | No | If present it will attempt to load the CSV file from the URL specified, otherwise it simply looks at the post for the data | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| Type | <String> | No | Directory | Import Type. Possible values include: Directory, Subjects or Evaluators (for 360 Projects), or Participants (for EE Projects) |
| CleanImport | [0,1] | No | If true, will remove any individuals that were not imported | |
| ClearRelationships | [0,1] | No | If true, will remove all relationships from the specified org structure before import | |
| UpdateResponses | [0,1] | No | If true, will update any responses given by the updated individuals with the metadata uploaded | |
| UseUniquePersonID | [0,1] | No | If true, will update any persons based on looking them up via the unique person id specified for the organization. If false, uses Email as the unique field. This is the only way to update email addresses and corresponding usernames. | |
| NoHierarchyUpdate | [0,1] | No | 0 | If true, will not update the people in the org hierarchies for the assessment |
This request removes a person from a 360 assessment or directory. If only a ThreeSixtyID is specified, this call removes the person from the 360 assessment. If only an Org Structure ID is specified, this call removes the person from the organization directory only.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| PersonID | <String> | Yes | The PersonID for the person to be removed | |
| ThreeSixtyID | <String> | No | The 360 (TS_) assessment in which you will be removing the person | |
| OrgStructureID | <String> | No | The Org Structure (OS_) directory in which you will be removing the person | |
| RemoveEvaluations | [0,1] | No | 0 | Remove Evaluations Given By This Person? 1 == yes, 0 == no. Default is no |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to reopen. |
This request resets a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Three Sixty to reset | |
| Cache | [0,1] | No | 0 | Clear the ThreeSixty Cache |
| Nominations | [0,1] | No | 0 | Remove all Nominations from 360 |
| Evaluations | [0,1] | No | 0 | Remove all Evaluations from 360 |
| Previews | [0,1] | No | 0 | Deletes and removes all preview survey responses from 360 |
| Participants | [0,1] | No | 0 | Remove all Participants from 360 |
| ReSync | [0,1] | No | 0 | Recalculate values and evaluations requirements |
This request sets custom relationships for a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The 360 ID | |
| jsonOfRelationships | <String> | No | The json of the custom relationships and their translations. Example:{"RL_0V8w4Pv4aBHG13n":{"EN":"Friend","ES":"Amigo "},"RL_23GpWwksHAZ053T":{"EN":"Enemy","ES":" Enemigo "},"RL_6sxXjX7aTPpvQ5n":{"EN":"Cohort","ES":" Cohorte"}}) |
Sets a Subject's status within a given assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.3 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Assessment ID (ThreeSixtyID; starts with TS_) | |
| SubjectID | <String> | Yes | The Subject ID (PersonID; starts with P_) | |
| Status | <String> | Yes | The Status (Done or Waiting) | |
| CloseSessions | [0,1] | No | 1 | Close all active form sessions and record them as partial data (applies when marking a subject as Done) |
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 RequestTo make a request to the API you need both a root URL and some basic parameters.Root URLThe root URL for communicating with the Qualtrics system is: https://yourdatacenterid.qualtrics.com/WRAPI/ThreeSixty/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.ParametersThe 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/ThreeSixty/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/ThreeSixty/api.php?Request=getLegacyResponseData&Format=XML Content-Type: application/json Request Body: {"User":"apiuser","Token":"lksjdfJdJklajdf3asdae3","SurveyID":"SV_123456789"}Required ParametersThe 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. |
| 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. |
| 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. |
The API uses a token based authentication system. This prevents you from needing to give out your password to third parties. Qualtrics needs both your user name and your token to authenticate your request. A request will be authenticated if a valid user name and token pair are passed as the 'User' and 'Token' parameters. Each Qualtrics user account can have one and only one token associated with it. The token never expires and can be regenerated at any time. To generate/regenerate your token:
This request activates an Orginization (Brand).
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | Yes | The Orginization ID |
Changes the user name from the old to the new user name
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OldUserName | <String> | Yes | The user name to be changed | |
| NewUserName | <String> | Yes | The new user name | |
| UserNameIsEmail | [0,1] | No | 1 | Default is 1. If 1 the user name must be an email address and the user’s email address will be updated in the system. It is strongly recommended to use email addresses as the user name. |
This request creates a new Division for a given Organization
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| DivisionID | <String> | No | If specified, will use this DivisionID | |
| Name | <String> | Yes | The name of this Division | |
| DivisionAdmins | <String> | No | The UserIDs of the desired Division Admins, passed as an array |
Create a new user
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| NewUsername | <String> | Yes | The name of the new user | |
| NewPassword | <String> | Yes | Password of new user | |
| FirstName | <String> | Yes | User’s first name | |
| LastName | <String> | Yes | User’s last name | |
| <String> | Yes | User’s email | ||
| Organization | <String> | Yes | Organization ID (Brand ID) | |
| Type | <String> | Yes | User Type | |
| DivisionID | <String> | No | Division ID |
This request deactivates an Orginization (Brand).
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | Yes | The Orginization ID |
Allows a 3rd party to check the status of all their subscriptions.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. |
Allows a 3rd party to check the status of a subscription.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber |
Gets all the User IDs for a Brand and/or Division To use this you must be the organization administrator or higher.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Organization | <String> | No | Specifies the Organization ID from which to obtain the User IDs. | |
| Division | <String> | No | (Optional) Specifies the Division ID from which to filter the User IDs. | |
| Offset | <String> | No | The index from which to begin the search. (Requires that a limit is provided as well) | |
| Limit | <String> | No | The maximum number of users to return. | |
| IncludeUserStats | [0,1] | No | 0 | (Optional) Set to 1 to include additional details and usage stats, including: total number of surveys, number of active surveys, and last survey response date. Note that this can significantly increase response time for especially large brands |
Allows a 3rd party client to subscribe to Qualtrics events. Topic subscription can be a single event * (Ex: 'threesixty.created') or a wildcard list of events using the * (star) notation to denote 'everything' (Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics.) Qualtrics Events include (but are not limited to): controlpanel.activateSurvey
| Attribute | Type | Description |
|---|---|---|
| Status | String | Active or Inactive, the result will be 'Active' if successful. |
| SurveyID | GUID | The Survey ID of the survey that has been activated |
| Attribute | Type | Description |
|---|---|---|
| Status | String | Active or Inactive, the result will be 'Inactive' if successful. |
| SurveyID | GUID | The Survey ID of the survey that has been deactivated |
| Attribute | Type | Description |
|---|---|---|
| Status | String | The status will always be Compete if successful. |
| SurveyID | GUID | The Survey ID of the survey whose response has been completed. |
| ResponseID | GUID | The Response ID of the response that has been completed. |
| RecipientID | GUID | The Recipient ID of the response that has been completed. Will only be included if non-null |
| ResponseEventContext | String | Custom context that can be set via the ResponseEventContext embeded data. 50 character limit |
| Attribute | Type | Description |
|---|---|---|
| Status | String | The status will always be Partial if successful. |
| SurveyID | GUID | The Survey ID of the survey whose partial response has been saved. |
| ResponseID | GUID | The Response ID of the response that has been recorded. |
| RecipientID | GUID | The Recipient ID of the response that has been recorded. Will only be included if non-null |
| ResponseEventContext | String | Custom context that can be set via the ResponseEventContext embeded data. 50 character limit |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The 360 the nomination was created for |
| SubjectID | GUID | The PersonID of the one doing the nominating; the one that will be evaluated |
| EvaluatorID | GUID | The PersonID of the one being nominated that will perform the evaluation |
| EvaluatorEmail | String | The Email Address of the person that will perform the evaluation |
| Relationship | String | The Relationship of the nomination |
| EvaluationURL | String | The Link to perform the evaluation (Survey Engine Link) |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The 360 the nomination was removed for |
| SubjectID | GUID | The PersonID of the one doing the nominating; the one that was to be evaluated |
| EvaluatorID | GUID | The PersonID of the one being nominated that was to perform the evaluation |
| Relationship | String | The Relationship of the nomination |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the newly-created 360 |
| SurveyID | GUID | The ID of associated survey |
| Workflow | JSON | The Workflow Settings |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the newly-created 360 |
| SubjectID | GUID | The PersonID of the person being evaluated |
| EvaluatorID | GUID | The PersonID of the one performing the evaluation |
| Status | String | The Status of the evaluation (Started, Finished) |
| SessionID | GUID | The SessionID of the initiated open survey session |
| ResponseID | GUID | (Optionally - When Finished) The ID of the Response |
| Relationship | String | The Relationship of the evaluation |
| Unsolicitied | Boolean | (Optionally - When Finished) Boolean TRUE if the response was unsolicited, FALSE otherwise |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| SubjectID | GUID | The PersonID of the subject of the report |
| ReportURL | String | The URL to view the report (Currently the link to log in to the Qualtrics Portal to view the report) |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| Status | String | Active or Inactive |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| SubjectID | GUID | The Person ID of the Subject |
| Status | String | Done or Waiting (Not Done) |
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber (we will make sure this is globally unique. All callers of this just need to ensure they are locally-unique.) | |
| PublicationURL | <URL> | Yes | The FULLY-Qualified URL to publish events to. For Example, if "http://mydomain.com/REST.php" it will publish messages to you via HTTP REST. The data pushed to the publication URL will be of Content-Type: application/x-www-urlencoded, NOT Content-Type: application/json | |
| Topics | <String> | Yes | String Value of Topics to subscribe to. Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics. | |
| Encrypt | [0,1] | No | 0 | If true, will encrypt the event messages using the supplied Shared Key. Encryption will be AES 128 or 256 depending on Shared Key length (16 bytes = 128 bit, 32 bytes = 256 bit). Encryption is not necessary if publishing to an https URL. * Encrypted MSG is Base64 encoded for transport purposes, therefore you must base64 decode the MSG before decrypting it. MSG plaintext will be in JSON format. |
| SharedKey | <String> | No | If specified, all event messages will be emitted with an HMAC using this key to guarantee message authenticity, and optionally encrypted using this key (if Encrypt = true). | |
| BrandID | <String> | No | If specified, subscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Allows a 3rd party client to unsubscribe to Qualtrics events. Any queued messages that have not been sent for that subscription will be deleted.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber | |
| BrandID | <String> | No | If specified, unsubscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Allows a 3rd party client to unsubscribe from all Qualtrics events.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | No | If specified, unsubscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Updates the specified User's information, based on UserID. To use this you must be the organization administrator or higher. For security reasons, you cannot set passwords for users other than yourself.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| UserID | <String> | Yes | ID of the user | |
| FirstName | <String> | No | First Name of user | |
| LastName | <String> | No | Last Name of user | |
| NewUsername | <String> | No | New Username of user | |
| NewPassword | <String> | No | New Password of user (can only set your own) | |
| <String> | No | New Email of user | ||
| Division | <String> | No | New Division ID of user | |
| UserType | <String> | No | New User Type | |
| Status | {Active, Disabled, NotVerified} | No | Updated Status for the user | |
| Permissions | <String> | No | JSON String representing the user permissions |
This request creates a new Message
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| Name | <String> | Yes | If specified, the name of the message | |
| Category | {InviteEmails, InactiveSurveyMessages, ReminderEmails, ThankYouEmails, EndOfSurveyMessages, GeneralMessages, ValidationMessages, LookAndFeelMessages, EmailSubject, SMSInvite, SMSReminder, SMSThankYou, TicketMessages} | Yes | The category of the new message | |
| Message | <String> | Yes | The text of the message to set; either an array mapping language codes to messages, or a single message to be set using the Language parameter | |
| Language | <String> | No | If specified, will set the translation in the specified language |
Removes A Graphic from a Library
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library that holds the graphic | |
| ImageID | <String> | Yes | The Image ID to Remove |
This request removes a Library Message based on ID
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| MessageID | <String> | Yes | The ID of the Message to Remove |
This request fetches the designated Message file
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| MessageID | <String> | Yes | The ID of the Message desired | |
| Language | <String> | No | If specified, will fetch the translation in the specified language (if available) |
Returns a list of library message ids.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message |
Gets all the IDs for a Library, such as message, image or panel
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library |
This request sets the designated Message text
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| MessageID | <String> | Yes | The ID of the Message desired | |
| Language | <String> | No | If specified, will set the translation in the specified language | |
| Message | <String> | Yes | The text of the message to set; either an array mapping language codes to messages, or a single message to be set using the Language parameter | |
| Name | <String> | No | If specified, will rename the message |
Uploads a Graphic to a Library
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library to hold the graphic | |
| Description | <String> | Yes | The name of the graphic | |
| Category | <String> | No | Unassigned | The Category to upload the graphic into |
| URL | <URL> | No | If set will expect the graphic to be located at this URL | |
| FileContents | <String> | No | If set will expect the Graphic File to be read into this parameter |
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ReportID | <String> | Yes | The Report ID for the report containing the Predefined Data Source.) | |
| DataSourceID | <String> | Yes | The Data Source ID for the Predefined Data Source to be updated. | |
| PredefinedData | <String> | No | A string of JSON-encoded predefined data to update the data source with | |
| URL | <URL> | No | The URL of an JSON file containing the new Data Source data |
Returns all of the response data for a survey in the original (legacy) data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, CSV, HTML, JSON} | Yes | The format the data will be transmitted in. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The survey you will be getting the responses for. | |
| LastResponseID | <String> | No | Each response is recorded sequentially. When specified it will export all responses after the id specified. | |
| Limit | <String> | No | The maximum number of responses to return. | |
| Offset | <String> | No | The starting index (inclusive) from which the responses will be retrieved. Combine with Limit to acheive pagination for responses in progress only. | |
| ResponseID | <String> | No | The response id of an individual response. ResponseSetID, SubgroupID, StartDate, and EndDate should not be specified when using this parameter. | |
| ResponseSetID | <String> | No | The response set you want to retrieve the data from. If not specified it will use the default response set. | |
| SubgroupID | <String> | No | The subgroup you want to download the data for. | |
| StartDate | YYYY-MM-DD hh:mm:ss | No | The date the responses must be after. | |
| EndDate | YYYY-MM-DD hh:mm:ss | No | The date the responses must be before. | |
| Questions | <String>%2C<String> | No | A comma separated list of question ids. Will filter the data to only include those specific questions. | |
| Labels | [0,1] | No | 0 | If 1 (true) the label for choices and answers will be used and not the id. The default is 0. |
| ExportTags | [0,1] | No | 0 | If 1 (true) the export tags will be used rather than the V labels. The default is 0. |
| ExportQuestionIDs | [0,1] | No | 0 | If 1 (true) the internal question IDs will be used rather than export tags or the V labels. The default is 0. |
| LocalTime | [0,1] | No | 1 | If 1 {true} the StartDate and EndDate will be exported using the specified user’s local time zone. |
| UnansweredRecode | <String> | No | The recode value for seen but unanswered questions. If not specified a blank value is put in for these questions. | |
| PanelID | <String> | No | If supplied it will only get the results for members of that specific panel. | |
| ResponsesInProgress | [0,1] | No | 0 | If 1 (true), will retrieve the responses in progress (and only the responses in progress). |
| LocationData | [0,1] | No | 0 | If 1 (true), will export location data. |
This request imports responses into the specified Employee Insights project. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format. The expected format of the file contents is the same format as the 'Evaluation Status' download with 'Include Response Data' checked.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the 360 into which we want to import responses. | |
| PulseID | <String> | No | The ID of the Pulse into which we want to import responses. | |
| URL | <URL> | No | If present it will import the file from the given url. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data |
Activates the specified Survey
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The Survey ID to activate |
Deactivates the specified Survey
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The Survey ID to deactivate |
Delete the specified survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | ID of the survey |
Gets all the quotas for a given survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | Survey ID of the survey in question. You must have permission to view responses on the given survey. |
Returns an HTML respresentation of the given response
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The response's associated survey ID | |
| ResponseID | <String> | Yes | The response to get HTML for | |
| ExcludeED | [0,1] | No | 0 | 1 to exclude embedded data. |
| ExcludeScoring | [0,1] | No | 0 | 1 to exclude scoring information. |
| ExcludeHiddenQuestions | [0,1] | No | 0 | 1 to exclude questions not displayed to the recipient. |
| ExcludeLocation | [0,1] | No | 0 | 1 to exclude location information. |
| IncludeHeader | [0,1] | No | 0 | 1 to include the header. |
This request returns an xml export of the survey. Version 2.3 includes an enhanced embedded data export, compound questions, and extended validation information. Additionally, choices are no longer ordered by choiceID, but rather by the order they appear in the survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Version | Version number like 'X.X' >= 2.3 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the survey whose xml definition will be retrieved. | |
| Language | <String> | No | The language code for the language you want to export the survey in. If not specified it will use the default language. Qualtrics generally adheres to the ISO 639-1 Standard for 2 character Language codes (http://en.wikipedia.org/wiki/ISO_639-1, ex. EN = English, ES = Spanish, DE = German). | |
| ExportLogic | [0,1] | No | 0 | EXPERIMENTAL. This is an experimental feature and subject to change without notice. Default 0. If 1 it will export the logic. |
This request returns the name of the survey as well as some addition information
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the survey. | |
| Language | <String> | No | The language code for the language you want to export the survey in. If not specified it will use the default language. |
This request returns a list of all the surveys for the user.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. |
This request imports a survey using the TXT or JSON format. The API assumes the file data was submitted in the POST. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ImportFormat | {TXT, QSF, DOC, MSQ} | No | TXT | The format of the import. |
| Name | <String> | Yes | The survey name. | |
| Activate | [0,1] | No | 0 | If FALSE (0) will be created in an Inactive state. If TRUE (1) will be created in an active state. |
| URL | <URL> | No | If present it will import the file from the given URL. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| OwnerID | <String> | No | UserID of caller | Specify the owner of this survey (a valid UserID or BrandID, Division and Group owned surveys are deprecated). Default owner is the user making this call. |
This request imports a set of survey translations using the CSV or XML format. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the Survey for which we are updating translations. | |
| URL | <URL> | No | If present it will import the file from the given URL. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| AsAdmin | [0,1] | No | TRUE if making this call on behalf of a survey that is owned by someone else in your org (As an Admin) |
Sets the survey options.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The survey options to be changed. | |
| Active | [0,1] | No | Activates or Deactivates the survey if specified. | |
| CloseSessions | [0,1] | No | 1 | When Active=0 this can be used to close all active sessions. |
| Expiration | [0,1] | No | Allows the survey to expire. The survey will only be valid between ExpirationStartDate and ExpirationEndDate. | |
| ExpirationStartDate | YYYY-MM-DD hh:mm:ss | No | When Expiration=1 the first date the survey will be valid. | |
| ExpirationEndDate | YYYY-MM-DD hh:mm:ss | No | When Expiration=1 the last date day the survey will be valid. | |
| SourceTimeZone | <String> | No |
This request transfers survey ownership to the specified user
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the Survey to change ownership | |
| SurveyName | <String> | No | The new name of the survey, if left empty will keep the current name | |
| OwnerID | <String> | Yes | The original owner of the survey | |
| NewOwnerID | <String> | Yes | The user that will receive ownership |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to activate. |
This request adds a person to a 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| PersonID | <String> | Yes | The Person ID | |
| ThreeSixtyID | <String> | Yes | The 360 you will be adding the person to. | |
| External | [0,1] | No | 0 | Denotes whether a person is external to the 360 (1 == external). Defaults to 0 if not present. For EE projects always set external = 1. |
| ForceUpdate | [0,1] | No | 0 | If the person is already in the assessment, this forces an update of the externality of the person specified. Defaults to 0 (just skip). |
Closes a specified 360 assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to close. | |
| CloseSessions | [0,1] | No | 1 | Whether to close partial form sessions or not. |
| DeleteMailings | [0,1] | No | 1 | Whether to delete any scheduled mailings. |
| ReadyReports | [0,1] | No | 1 | Whether to ready the reports or not. |
Creates an Assessment
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.3 | Yes | The version of the API to use. | |
| Name | <String> | Yes | The name of the assessment. | |
| ThreeSixtyID | <String> | No | If supplied, will use this ID for the newly-created assessment. | |
| OwnerID | <String> | No | The owner of the assessment (User ID, Group ID, Division ID or Brand ID). Assessment is made public to the entire organization if owner is set to the Brand ID. | |
| SurveyID | <String> | No | If supplied, will associate this Form ID with this assessment, and not create a new form. | |
| WorkFlowOptions | <String> | No | Optional workflow options. | |
| Relationships | <String> | No | Optional relationships this assessment will use. | |
| Type | <String> | No | 360 | The type of Assessment to create. default=360. Options are 360, EE or EmployeePulse |
This request creates a new person in the provided Organization Structure
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| <String> | Yes | The email for the new person, will also be the username | ||
| FirstName | <String> | Yes | The first name of the new person. | |
| LastName | <String> | Yes | The last name for the new person. | |
| UserName | <String> | No | Optionally specify the username of the person you are creating. Defaults to the email. | |
| OrgStructureID | <String> | No | The organization structure ID | |
| PersonID | <String> | No | The PersonID for the person to be created must be valid unused person GUID | |
| DivisionID | <String> | No | The division if wanted to place the new person/user in | |
| External | [0,1] | No | 0 | Is the person an external? 1== external, 0 == not external |
| MetaData | <String> | No | The custom MetaData for the new person passed as an array |
** DEPRECATED in 2.3. Use CreateAssessment instead.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | The name of the assessment. | |
| ThreeSixtyID | <String> | No | If supplied, will use this ID for the newly-created assessment. | |
| OwnerID | <String> | No | The owner of the assessment (User ID, Group ID or Division ID). | |
| SurveyID | <String> | No | If supplied, will associate this Form ID with this assessment, and not create a new form. | |
| WorkFlowOptions | <String> | No | Optional workflow options. | |
| Relationships | <String> | No | Optional relationships this assessment will use. | |
| NewAssessment | [0,1] | No | 0 | The type of Assessment to create. defaults to a classic threesixty (false) true creates a new Assessment |
This request deletes the specified assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you would like to delete. |
This request deletes the specified user.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| UserID | <String> | Yes | The ID of the user you would like to delete. |
This request returns the custom relationships for a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The 360 ID |
This request returns a PDF of the specified report.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| ReportID | <String> | Yes | The Report ID |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want the definition for. |
Returns a list of all the assessments for the users brand.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. |
Returns a CSV containing the Evaluation Status for the specified Assessment
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment for which you want the evaluation status. | |
| IncludeEvaluationResponses | [0,1] | No | 0 | Whether or not to include response data with the evaluations. |
| Questions | <String>%2C<String> | No | A comma separated list of Question IDs. Will filter the data to only include those specific questions, if IncludeEvaluationResponses is enabled. | |
| IncludeEvaluatorMetadata | [0,1] | No | 0 | Whether or not to include the metadata for the Evaluator on each row. |
| IncludeSubjectMetadata | [0,1] | No | 0 | Whether or not to include the metadata for the Subject on each row. |
This request returns all persons in the organization
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | No | The organization structure ID | |
| IncludeMetaData | [0,1] | No | 0 | If 1, includes metadata for each person |
| StartIndex | <String> | No | 0 | The start index |
| RecordLimit | <String> | No | The maximum number of records to return. Defaults to unlimited. |
This request returns the persons in the organization below the specified person
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | Yes | The organization structure ID | |
| PersonID | <String> | Yes | Everyone below this person |
Returns a CSV containing the Response Status for the specified Pulse
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 1.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the project for which you want the response status. | |
| PulseID | <String> | Yes | The ID of the pulse for which you want the response status. | |
| Questions | <String>%2C<String> | No | A comma separated list of Question IDs. Will filter the data to only include those specific questions, if IncludeEvaluationResponses is enabled. |
This request returns a PDF of the specified person’s subject report for a given 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID | |
| PersonID | <String> | Yes | The subject of the report | |
| Viewer | <String> | No | Subject | The viewer of the report -- either a Person ID of the viewer, Admin or Subject. If a Person ID, will use that person as the viewer. If Admin, the viewer will be the person making this API call. If Subject, the viewer is the Subject PersonID specified above. |
This request returns a specified person’s subject report data for a given 360 Assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID | |
| PersonID | <String> | Yes | The subject of the report |
This request returns the export of all the subjects' status for a given 360 Assessment. Currently only CSV output format is supported.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The format the data will be transmitted in. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID |
Gets back the User Data Fields for the brand
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. |
This request imports a CSV list of persons (in batch) into the specified organization. The CSV file can be posted (there is an approximate 8 megabytes limit) or a URL can be given to retrieve the file from a remote server. The CSV file must contain a header row and be comma separated using “ for encapsulation
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | No | The organization structure ID to import the persons into. Leave blank if using ThreeSixtyID (uses the org structure ID of the assessment) | |
| ThreeSixtyID | <String> | No | The 360 you will be importing the persons into as subjects. Leave blank if you do not want them to be added as subjects | |
| URL | <String> | No | If present it will attempt to load the CSV file from the URL specified, otherwise it simply looks at the post for the data | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| Type | <String> | No | Directory | Import Type. Possible values include: Directory, Subjects or Evaluators (for 360 Projects), or Participants (for EE Projects) |
| CleanImport | [0,1] | No | If true, will remove any individuals that were not imported | |
| ClearRelationships | [0,1] | No | If true, will remove all relationships from the specified org structure before import | |
| UpdateResponses | [0,1] | No | If true, will update any responses given by the updated individuals with the metadata uploaded | |
| UseUniquePersonID | [0,1] | No | If true, will update any persons based on looking them up via the unique person id specified for the organization. If false, uses Email as the unique field. This is the only way to update email addresses and corresponding usernames. | |
| NoHierarchyUpdate | [0,1] | No | 0 | If true, will not update the people in the org hierarchies for the assessment |
This request removes a person from a 360 assessment or directory. If only a ThreeSixtyID is specified, this call removes the person from the 360 assessment. If only an Org Structure ID is specified, this call removes the person from the organization directory only.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| PersonID | <String> | Yes | The PersonID for the person to be removed | |
| ThreeSixtyID | <String> | No | The 360 (TS_) assessment in which you will be removing the person | |
| OrgStructureID | <String> | No | The Org Structure (OS_) directory in which you will be removing the person | |
| RemoveEvaluations | [0,1] | No | 0 | Remove Evaluations Given By This Person? 1 == yes, 0 == no. Default is no |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to reopen. |
This request resets a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Three Sixty to reset | |
| Cache | [0,1] | No | 0 | Clear the ThreeSixty Cache |
| Nominations | [0,1] | No | 0 | Remove all Nominations from 360 |
| Evaluations | [0,1] | No | 0 | Remove all Evaluations from 360 |
| Previews | [0,1] | No | 0 | Deletes and removes all preview survey responses from 360 |
| Participants | [0,1] | No | 0 | Remove all Participants from 360 |
| ReSync | [0,1] | No | 0 | Recalculate values and evaluations requirements |
This request sets custom relationships for a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The 360 ID | |
| jsonOfRelationships | <String> | No | The json of the custom relationships and their translations. Example:{"RL_0V8w4Pv4aBHG13n":{"EN":"Friend","ES":"Amigo "},"RL_23GpWwksHAZ053T":{"EN":"Enemy","ES":" Enemigo "},"RL_6sxXjX7aTPpvQ5n":{"EN":"Cohort","ES":" Cohorte"}}) |
Sets a Subject's status within a given assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.3 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Assessment ID (ThreeSixtyID; starts with TS_) | |
| SubjectID | <String> | Yes | The Subject ID (PersonID; starts with P_) | |
| Status | <String> | Yes | The Status (Done or Waiting) | |
| CloseSessions | [0,1] | No | 1 | Close all active form sessions and record them as partial data (applies when marking a subject as Done) |
Updates/Sets the User Data Fields for the Brand
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| DefaultSettings | <String> | No | If set will update the default settings with the values included, ex: {"Photo": true, "FirstName": true, "LastName": true, "Email": false} | |
| OptionalSettings | <String> | No | If set will add / update additional settings. ex: OptionalSettings -> {Language": {"CanEdit": true, "Required": false, "Type": "MultipleChoice", "Choices": ["EN", "ES"]}, "Age": {"CanEdit": true, "Required": false, "Type": "TextEntry"} |
Updates an Assessment
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | Will update this assessment. | |
| SurveyID | <String> | No | If supplied, will update the survey for this assessment; deleting the old survey. | |
| WorkFlowOptions | <String> | No | If supplied, will update the workflow options. Only values that are specified will be overwritten. Does not replace entire workflow settings. |
Updates a Person. It's recommended to run updateUser instead of this API to update Email, FirstName and LastName. If you do need to update MetaData, please use updateUser and updatePerson in conjuction to avoid breaking the link between user and person.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| PersonID | <String> | Yes | The Person to update | |
| FirstName | <String> | No | If supplied, sets the First Name to this value | |
| LastName | <String> | No | If supplied, sets the Last Name to this value | |
| <String> | No | If supplied, sets the Email Address to this value | ||
| MetaData | <String> | No | JSON String of MetaData Key:Values that will be used if included |
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 RequestTo make a request to the API you need both a root URL and some basic parameters.Root URLThe root URL for communicating with the Qualtrics system is: https://yourdatacenterid.qualtrics.com/WRAPI/ThreeSixty/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.ParametersThe 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/ThreeSixty/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/ThreeSixty/api.php?Request=getLegacyResponseData&Format=XML Content-Type: application/json Request Body: {"User":"apiuser","Token":"lksjdfJdJklajdf3asdae3","SurveyID":"SV_123456789"}Required ParametersThe 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. |
| 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. |
| 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. |
The API uses a token based authentication system. This prevents you from needing to give out your password to third parties. Qualtrics needs both your user name and your token to authenticate your request. A request will be authenticated if a valid user name and token pair are passed as the 'User' and 'Token' parameters. Each Qualtrics user account can have one and only one token associated with it. The token never expires and can be regenerated at any time. To generate/regenerate your token:
This request activates an Orginization (Brand).
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | Yes | The Orginization ID |
Changes the user name from the old to the new user name
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OldUserName | <String> | Yes | The user name to be changed | |
| NewUserName | <String> | Yes | The new user name | |
| UserNameIsEmail | [0,1] | No | 1 | Default is 1. If 1 the user name must be an email address and the user’s email address will be updated in the system. It is strongly recommended to use email addresses as the user name. |
This request creates a new Division for a given Organization
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| DivisionID | <String> | No | If specified, will use this DivisionID | |
| Name | <String> | Yes | The name of this Division | |
| DivisionAdmins | <String> | No | The UserIDs of the desired Division Admins, passed as an array |
Create a new user
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| NewUsername | <String> | Yes | The name of the new user | |
| NewPassword | <String> | Yes | Password of new user | |
| FirstName | <String> | Yes | User’s first name | |
| LastName | <String> | Yes | User’s last name | |
| <String> | Yes | User’s email | ||
| Organization | <String> | Yes | Organization ID (Brand ID) | |
| Type | <String> | Yes | User Type | |
| DivisionID | <String> | No | Division ID |
This request deactivates an Orginization (Brand).
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | Yes | The Orginization ID |
Allows a 3rd party to check the status of all their subscriptions.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. |
Allows a 3rd party to check the status of a subscription.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber |
Gets all the User IDs for a Brand and/or Division To use this you must be the organization administrator or higher.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Organization | <String> | No | Specifies the Organization ID from which to obtain the User IDs. | |
| Division | <String> | No | (Optional) Specifies the Division ID from which to filter the User IDs. | |
| Offset | <String> | No | The index from which to begin the search. (Requires that a limit is provided as well) | |
| Limit | <String> | No | The maximum number of users to return. | |
| IncludeUserStats | [0,1] | No | 0 | (Optional) Set to 1 to include additional details and usage stats, including: total number of surveys, number of active surveys, and last survey response date. Note that this can significantly increase response time for especially large brands |
Allows a 3rd party client to subscribe to Qualtrics events. Topic subscription can be a single event * (Ex: 'threesixty.created') or a wildcard list of events using the * (star) notation to denote 'everything' (Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics.) Qualtrics Events include (but are not limited to): controlpanel.activateSurvey
| Attribute | Type | Description |
|---|---|---|
| Status | String | Active or Inactive, the result will be 'Active' if successful. |
| SurveyID | GUID | The Survey ID of the survey that has been activated |
| Attribute | Type | Description |
|---|---|---|
| Status | String | Active or Inactive, the result will be 'Inactive' if successful. |
| SurveyID | GUID | The Survey ID of the survey that has been deactivated |
| Attribute | Type | Description |
|---|---|---|
| Status | String | The status will always be Compete if successful. |
| SurveyID | GUID | The Survey ID of the survey whose response has been completed. |
| ResponseID | GUID | The Response ID of the response that has been completed. |
| RecipientID | GUID | The Recipient ID of the response that has been completed. Will only be included if non-null |
| ResponseEventContext | String | Custom context that can be set via the ResponseEventContext embeded data. 50 character limit |
| Attribute | Type | Description |
|---|---|---|
| Status | String | The status will always be Partial if successful. |
| SurveyID | GUID | The Survey ID of the survey whose partial response has been saved. |
| ResponseID | GUID | The Response ID of the response that has been recorded. |
| RecipientID | GUID | The Recipient ID of the response that has been recorded. Will only be included if non-null |
| ResponseEventContext | String | Custom context that can be set via the ResponseEventContext embeded data. 50 character limit |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The 360 the nomination was created for |
| SubjectID | GUID | The PersonID of the one doing the nominating; the one that will be evaluated |
| EvaluatorID | GUID | The PersonID of the one being nominated that will perform the evaluation |
| EvaluatorEmail | String | The Email Address of the person that will perform the evaluation |
| Relationship | String | The Relationship of the nomination |
| EvaluationURL | String | The Link to perform the evaluation (Survey Engine Link) |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The 360 the nomination was removed for |
| SubjectID | GUID | The PersonID of the one doing the nominating; the one that was to be evaluated |
| EvaluatorID | GUID | The PersonID of the one being nominated that was to perform the evaluation |
| Relationship | String | The Relationship of the nomination |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the newly-created 360 |
| SurveyID | GUID | The ID of associated survey |
| Workflow | JSON | The Workflow Settings |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the newly-created 360 |
| SubjectID | GUID | The PersonID of the person being evaluated |
| EvaluatorID | GUID | The PersonID of the one performing the evaluation |
| Status | String | The Status of the evaluation (Started, Finished) |
| SessionID | GUID | The SessionID of the initiated open survey session |
| ResponseID | GUID | (Optionally - When Finished) The ID of the Response |
| Relationship | String | The Relationship of the evaluation |
| Unsolicitied | Boolean | (Optionally - When Finished) Boolean TRUE if the response was unsolicited, FALSE otherwise |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| SubjectID | GUID | The PersonID of the subject of the report |
| ReportURL | String | The URL to view the report (Currently the link to log in to the Qualtrics Portal to view the report) |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| Status | String | Active or Inactive |
| Attribute | Type | Description |
|---|---|---|
| ThreeSixtyID | GUID | The ID of the 360 |
| SubjectID | GUID | The Person ID of the Subject |
| Status | String | Done or Waiting (Not Done) |
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber (we will make sure this is globally unique. All callers of this just need to ensure they are locally-unique.) | |
| PublicationURL | <URL> | Yes | The FULLY-Qualified URL to publish events to. For Example, if "http://mydomain.com/REST.php" it will publish messages to you via HTTP REST. The data pushed to the publication URL will be of Content-Type: application/x-www-urlencoded, NOT Content-Type: application/json | |
| Topics | <String> | Yes | String Value of Topics to subscribe to. Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics. | |
| Encrypt | [0,1] | No | 0 | If true, will encrypt the event messages using the supplied Shared Key. Encryption will be AES 128 or 256 depending on Shared Key length (16 bytes = 128 bit, 32 bytes = 256 bit). Encryption is not necessary if publishing to an https URL. * Encrypted MSG is Base64 encoded for transport purposes, therefore you must base64 decode the MSG before decrypting it. MSG plaintext will be in JSON format. |
| SharedKey | <String> | No | If specified, all event messages will be emitted with an HMAC using this key to guarantee message authenticity, and optionally encrypted using this key (if Encrypt = true). | |
| BrandID | <String> | No | If specified, subscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Allows a 3rd party client to unsubscribe to Qualtrics events. Any queued messages that have not been sent for that subscription will be deleted.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | Unique Textual Description of the subscriber | |
| BrandID | <String> | No | If specified, unsubscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Allows a 3rd party client to unsubscribe from all Qualtrics events.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| BrandID | <String> | No | If specified, unsubscribe on behalf of the supplied organization. For administrators of multiple organizations only. |
Updates the specified User's information, based on UserID. To use this you must be the organization administrator or higher. For security reasons, you cannot set passwords for users other than yourself.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| UserID | <String> | Yes | ID of the user | |
| FirstName | <String> | No | First Name of user | |
| LastName | <String> | No | Last Name of user | |
| NewUsername | <String> | No | New Username of user | |
| NewPassword | <String> | No | New Password of user (can only set your own) | |
| <String> | No | New Email of user | ||
| Division | <String> | No | New Division ID of user | |
| UserType | <String> | No | New User Type | |
| Status | {Active, Disabled, NotVerified} | No | Updated Status for the user | |
| Permissions | <String> | No | JSON String representing the user permissions |
This request creates a new Message
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| Name | <String> | Yes | If specified, the name of the message | |
| Category | {InviteEmails, InactiveSurveyMessages, ReminderEmails, ThankYouEmails, EndOfSurveyMessages, GeneralMessages, ValidationMessages, LookAndFeelMessages, EmailSubject, SMSInvite, SMSReminder, SMSThankYou, TicketMessages} | Yes | The category of the new message | |
| Message | <String> | Yes | The text of the message to set; either an array mapping language codes to messages, or a single message to be set using the Language parameter | |
| Language | <String> | No | If specified, will set the translation in the specified language |
Removes A Graphic from a Library
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library that holds the graphic | |
| ImageID | <String> | Yes | The Image ID to Remove |
This request removes a Library Message based on ID
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| MessageID | <String> | Yes | The ID of the Message to Remove |
This request fetches the designated Message file
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| MessageID | <String> | Yes | The ID of the Message desired | |
| Language | <String> | No | If specified, will fetch the translation in the specified language (if available) |
Returns a list of library message ids.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message |
Gets all the IDs for a Library, such as message, image or panel
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library |
This request sets the designated Message text
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library containing the Message | |
| MessageID | <String> | Yes | The ID of the Message desired | |
| Language | <String> | No | If specified, will set the translation in the specified language | |
| Message | <String> | Yes | The text of the message to set; either an array mapping language codes to messages, or a single message to be set using the Language parameter | |
| Name | <String> | No | If specified, will rename the message |
Uploads a Graphic to a Library
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| LibraryID | <String> | Yes | The ID of the Library to hold the graphic | |
| Description | <String> | Yes | The name of the graphic | |
| Category | <String> | No | Unassigned | The Category to upload the graphic into |
| URL | <URL> | No | If set will expect the graphic to be located at this URL | |
| FileContents | <String> | No | If set will expect the Graphic File to be read into this parameter |
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ReportID | <String> | Yes | The Report ID for the report containing the Predefined Data Source.) | |
| DataSourceID | <String> | Yes | The Data Source ID for the Predefined Data Source to be updated. | |
| PredefinedData | <String> | No | A string of JSON-encoded predefined data to update the data source with | |
| URL | <URL> | No | The URL of an JSON file containing the new Data Source data |
Returns all of the response data for a survey in the original (legacy) data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, CSV, HTML, JSON} | Yes | The format the data will be transmitted in. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The survey you will be getting the responses for. | |
| LastResponseID | <String> | No | Each response is recorded sequentially. When specified it will export all responses after the id specified. | |
| Limit | <String> | No | The maximum number of responses to return. | |
| Offset | <String> | No | The starting index (inclusive) from which the responses will be retrieved. Combine with Limit to acheive pagination for responses in progress only. | |
| ResponseID | <String> | No | The response id of an individual response. ResponseSetID, SubgroupID, StartDate, and EndDate should not be specified when using this parameter. | |
| ResponseSetID | <String> | No | The response set you want to retrieve the data from. If not specified it will use the default response set. | |
| SubgroupID | <String> | No | The subgroup you want to download the data for. | |
| StartDate | YYYY-MM-DD hh:mm:ss | No | The date the responses must be after. | |
| EndDate | YYYY-MM-DD hh:mm:ss | No | The date the responses must be before. | |
| Questions | <String>%2C<String> | No | A comma separated list of question ids. Will filter the data to only include those specific questions. | |
| Labels | [0,1] | No | 0 | If 1 (true) the label for choices and answers will be used and not the id. The default is 0. |
| ExportTags | [0,1] | No | 0 | If 1 (true) the export tags will be used rather than the V labels. The default is 0. |
| ExportQuestionIDs | [0,1] | No | 0 | If 1 (true) the internal question IDs will be used rather than export tags or the V labels. The default is 0. |
| LocalTime | [0,1] | No | 1 | If 1 {true} the StartDate and EndDate will be exported using the specified user’s local time zone. |
| UnansweredRecode | <String> | No | The recode value for seen but unanswered questions. If not specified a blank value is put in for these questions. | |
| PanelID | <String> | No | If supplied it will only get the results for members of that specific panel. | |
| ResponsesInProgress | [0,1] | No | 0 | If 1 (true), will retrieve the responses in progress (and only the responses in progress). |
| LocationData | [0,1] | No | 0 | If 1 (true), will export location data. |
This request imports responses into the specified Employee Insights project. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format. The expected format of the file contents is the same format as the 'Evaluation Status' download with 'Include Response Data' checked.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the 360 into which we want to import responses. | |
| PulseID | <String> | No | The ID of the Pulse into which we want to import responses. | |
| URL | <URL> | No | If present it will import the file from the given url. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data |
Activates the specified Survey
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The Survey ID to activate |
Deactivates the specified Survey
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The Survey ID to deactivate |
Delete the specified survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | ID of the survey |
Gets all the quotas for a given survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | Survey ID of the survey in question. You must have permission to view responses on the given survey. |
Returns an HTML respresentation of the given response
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The response's associated survey ID | |
| ResponseID | <String> | Yes | The response to get HTML for | |
| ExcludeED | [0,1] | No | 0 | 1 to exclude embedded data. |
| ExcludeScoring | [0,1] | No | 0 | 1 to exclude scoring information. |
| ExcludeHiddenQuestions | [0,1] | No | 0 | 1 to exclude questions not displayed to the recipient. |
| ExcludeLocation | [0,1] | No | 0 | 1 to exclude location information. |
| IncludeHeader | [0,1] | No | 0 | 1 to include the header. |
This request returns an xml export of the survey. Version 2.3 includes an enhanced embedded data export, compound questions, and extended validation information. Additionally, choices are no longer ordered by choiceID, but rather by the order they appear in the survey.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Version | Version number like 'X.X' >= 2.3 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the survey whose xml definition will be retrieved. | |
| Language | <String> | No | The language code for the language you want to export the survey in. If not specified it will use the default language. Qualtrics generally adheres to the ISO 639-1 Standard for 2 character Language codes (http://en.wikipedia.org/wiki/ISO_639-1, ex. EN = English, ES = Spanish, DE = German). | |
| ExportLogic | [0,1] | No | 0 | EXPERIMENTAL. This is an experimental feature and subject to change without notice. Default 0. If 1 it will export the logic. |
This request returns the name of the survey as well as some addition information
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the survey. | |
| Language | <String> | No | The language code for the language you want to export the survey in. If not specified it will use the default language. |
This request returns a list of all the surveys for the user.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. |
This request imports a survey using the TXT or JSON format. The API assumes the file data was submitted in the POST. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ImportFormat | {TXT, QSF, DOC, MSQ} | No | TXT | The format of the import. |
| Name | <String> | Yes | The survey name. | |
| Activate | [0,1] | No | 0 | If FALSE (0) will be created in an Inactive state. If TRUE (1) will be created in an active state. |
| URL | <URL> | No | If present it will import the file from the given URL. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| OwnerID | <String> | No | UserID of caller | Specify the owner of this survey (a valid UserID or BrandID, Division and Group owned surveys are deprecated). Default owner is the user making this call. |
This request imports a set of survey translations using the CSV or XML format. If URL is specified then the file data is read from the URL. If FileContents is present then it will assume the data was posted using multipart/form-data format.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the Survey for which we are updating translations. | |
| URL | <URL> | No | If present it will import the file from the given URL. | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| AsAdmin | [0,1] | No | TRUE if making this call on behalf of a survey that is owned by someone else in your org (As an Admin) |
Sets the survey options.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The survey options to be changed. | |
| Active | [0,1] | No | Activates or Deactivates the survey if specified. | |
| CloseSessions | [0,1] | No | 1 | When Active=0 this can be used to close all active sessions. |
| Expiration | [0,1] | No | Allows the survey to expire. The survey will only be valid between ExpirationStartDate and ExpirationEndDate. | |
| ExpirationStartDate | YYYY-MM-DD hh:mm:ss | No | When Expiration=1 the first date the survey will be valid. | |
| ExpirationEndDate | YYYY-MM-DD hh:mm:ss | No | When Expiration=1 the last date day the survey will be valid. | |
| SourceTimeZone | <String> | No |
This request transfers survey ownership to the specified user
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| SurveyID | <String> | Yes | The ID of the Survey to change ownership | |
| SurveyName | <String> | No | The new name of the survey, if left empty will keep the current name | |
| OwnerID | <String> | Yes | The original owner of the survey | |
| NewOwnerID | <String> | Yes | The user that will receive ownership |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to activate. |
This request adds a person to a 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| PersonID | <String> | Yes | The Person ID | |
| ThreeSixtyID | <String> | Yes | The 360 you will be adding the person to. | |
| External | [0,1] | No | 0 | Denotes whether a person is external to the 360 (1 == external). Defaults to 0 if not present. For EE projects always set external = 1. |
| ForceUpdate | [0,1] | No | 0 | If the person is already in the assessment, this forces an update of the externality of the person specified. Defaults to 0 (just skip). |
Closes a specified 360 assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to close. | |
| CloseSessions | [0,1] | No | 1 | Whether to close partial form sessions or not. |
| DeleteMailings | [0,1] | No | 1 | Whether to delete any scheduled mailings. |
| ReadyReports | [0,1] | No | 1 | Whether to ready the reports or not. |
Creates an Assessment
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.3 | Yes | The version of the API to use. | |
| Name | <String> | Yes | The name of the assessment. | |
| ThreeSixtyID | <String> | No | If supplied, will use this ID for the newly-created assessment. | |
| OwnerID | <String> | No | The owner of the assessment (User ID, Group ID, Division ID or Brand ID). Assessment is made public to the entire organization if owner is set to the Brand ID. | |
| SurveyID | <String> | No | If supplied, will associate this Form ID with this assessment, and not create a new form. | |
| WorkFlowOptions | <String> | No | Optional workflow options. | |
| Relationships | <String> | No | Optional relationships this assessment will use. | |
| Type | <String> | No | 360 | The type of Assessment to create. default=360. Options are 360, EE or EmployeePulse |
This request creates a new person in the provided Organization Structure
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| <String> | Yes | The email for the new person, will also be the username | ||
| FirstName | <String> | Yes | The first name of the new person. | |
| LastName | <String> | Yes | The last name for the new person. | |
| UserName | <String> | No | Optionally specify the username of the person you are creating. Defaults to the email. | |
| OrgStructureID | <String> | No | The organization structure ID | |
| PersonID | <String> | No | The PersonID for the person to be created must be valid unused person GUID | |
| DivisionID | <String> | No | The division if wanted to place the new person/user in | |
| External | [0,1] | No | 0 | Is the person an external? 1== external, 0 == not external |
| MetaData | <String> | No | The custom MetaData for the new person passed as an array |
** DEPRECATED in 2.3. Use CreateAssessment instead.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| Name | <String> | Yes | The name of the assessment. | |
| ThreeSixtyID | <String> | No | If supplied, will use this ID for the newly-created assessment. | |
| OwnerID | <String> | No | The owner of the assessment (User ID, Group ID or Division ID). | |
| SurveyID | <String> | No | If supplied, will associate this Form ID with this assessment, and not create a new form. | |
| WorkFlowOptions | <String> | No | Optional workflow options. | |
| Relationships | <String> | No | Optional relationships this assessment will use. | |
| NewAssessment | [0,1] | No | 0 | The type of Assessment to create. defaults to a classic threesixty (false) true creates a new Assessment |
This request deletes the specified assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you would like to delete. |
This request deletes the specified user.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| UserID | <String> | Yes | The ID of the user you would like to delete. |
This request returns the custom relationships for a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The 360 ID |
This request returns a PDF of the specified report.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| ReportID | <String> | Yes | The Report ID |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want the definition for. |
Returns a list of all the assessments for the users brand.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. |
Returns a CSV containing the Evaluation Status for the specified Assessment
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment for which you want the evaluation status. | |
| IncludeEvaluationResponses | [0,1] | No | 0 | Whether or not to include response data with the evaluations. |
| Questions | <String>%2C<String> | No | A comma separated list of Question IDs. Will filter the data to only include those specific questions, if IncludeEvaluationResponses is enabled. | |
| IncludeEvaluatorMetadata | [0,1] | No | 0 | Whether or not to include the metadata for the Evaluator on each row. |
| IncludeSubjectMetadata | [0,1] | No | 0 | Whether or not to include the metadata for the Subject on each row. |
This request returns all persons in the organization
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | No | The organization structure ID | |
| IncludeMetaData | [0,1] | No | 0 | If 1, includes metadata for each person |
| StartIndex | <String> | No | 0 | The start index |
| RecordLimit | <String> | No | The maximum number of records to return. Defaults to unlimited. |
This request returns the persons in the organization below the specified person
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | Yes | The organization structure ID | |
| PersonID | <String> | Yes | Everyone below this person |
Returns a CSV containing the Response Status for the specified Pulse
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 1.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the project for which you want the response status. | |
| PulseID | <String> | Yes | The ID of the pulse for which you want the response status. | |
| Questions | <String>%2C<String> | No | A comma separated list of Question IDs. Will filter the data to only include those specific questions, if IncludeEvaluationResponses is enabled. |
This request returns a PDF of the specified person’s subject report for a given 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID | |
| PersonID | <String> | Yes | The subject of the report | |
| Viewer | <String> | No | Subject | The viewer of the report -- either a Person ID of the viewer, Admin or Subject. If a Person ID, will use that person as the viewer. If Admin, the viewer will be the person making this API call. If Subject, the viewer is the Subject PersonID specified above. |
This request returns a specified person’s subject report data for a given 360 Assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID | |
| PersonID | <String> | Yes | The subject of the report |
This request returns the export of all the subjects' status for a given 360 Assessment. Currently only CSV output format is supported.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {CSV} | Yes | The format the data will be transmitted in. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Qualtrics 360 ID |
Gets back the User Data Fields for the brand
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. |
This request imports a CSV list of persons (in batch) into the specified organization. The CSV file can be posted (there is an approximate 8 megabytes limit) or a URL can be given to retrieve the file from a remote server. The CSV file must contain a header row and be comma separated using “ for encapsulation
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| OrgStructureID | <String> | No | The organization structure ID to import the persons into. Leave blank if using ThreeSixtyID (uses the org structure ID of the assessment) | |
| ThreeSixtyID | <String> | No | The 360 you will be importing the persons into as subjects. Leave blank if you do not want them to be added as subjects | |
| URL | <String> | No | If present it will attempt to load the CSV file from the URL specified, otherwise it simply looks at the post for the data | |
| FileContents | <String> | No | The contents of the file posted using multipart/form-data | |
| Type | <String> | No | Directory | Import Type. Possible values include: Directory, Subjects or Evaluators (for 360 Projects), or Participants (for EE Projects) |
| CleanImport | [0,1] | No | If true, will remove any individuals that were not imported | |
| ClearRelationships | [0,1] | No | If true, will remove all relationships from the specified org structure before import | |
| UpdateResponses | [0,1] | No | If true, will update any responses given by the updated individuals with the metadata uploaded | |
| UseUniquePersonID | [0,1] | No | If true, will update any persons based on looking them up via the unique person id specified for the organization. If false, uses Email as the unique field. This is the only way to update email addresses and corresponding usernames. | |
| NoHierarchyUpdate | [0,1] | No | 0 | If true, will not update the people in the org hierarchies for the assessment |
This request removes a person from a 360 assessment or directory. If only a ThreeSixtyID is specified, this call removes the person from the 360 assessment. If only an Org Structure ID is specified, this call removes the person from the organization directory only.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| PersonID | <String> | Yes | The PersonID for the person to be removed | |
| ThreeSixtyID | <String> | No | The 360 (TS_) assessment in which you will be removing the person | |
| OrgStructureID | <String> | No | The Org Structure (OS_) directory in which you will be removing the person | |
| RemoveEvaluations | [0,1] | No | 0 | Remove Evaluations Given By This Person? 1 == yes, 0 == no. Default is no |
Returns the definition for the specified 360.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.1 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The ID of the assessment you want to reopen. |
This request resets a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Three Sixty to reset | |
| Cache | [0,1] | No | 0 | Clear the ThreeSixty Cache |
| Nominations | [0,1] | No | 0 | Remove all Nominations from 360 |
| Evaluations | [0,1] | No | 0 | Remove all Evaluations from 360 |
| Previews | [0,1] | No | 0 | Deletes and removes all preview survey responses from 360 |
| Participants | [0,1] | No | 0 | Remove all Participants from 360 |
| ReSync | [0,1] | No | 0 | Recalculate values and evaluations requirements |
This request sets custom relationships for a 360
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.0 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The 360 ID | |
| jsonOfRelationships | <String> | No | The json of the custom relationships and their translations. Example:{"RL_0V8w4Pv4aBHG13n":{"EN":"Friend","ES":"Amigo "},"RL_23GpWwksHAZ053T":{"EN":"Enemy","ES":" Enemigo "},"RL_6sxXjX7aTPpvQ5n":{"EN":"Cohort","ES":" Cohorte"}}) |
Sets a Subject's status within a given assessment.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.3 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | The Assessment ID (ThreeSixtyID; starts with TS_) | |
| SubjectID | <String> | Yes | The Subject ID (PersonID; starts with P_) | |
| Status | <String> | Yes | The Status (Done or Waiting) | |
| CloseSessions | [0,1] | No | 1 | Close all active form sessions and record them as partial data (applies when marking a subject as Done) |
Updates/Sets the User Data Fields for the Brand
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| DefaultSettings | <String> | No | If set will update the default settings with the values included, ex: {"Photo": true, "FirstName": true, "LastName": true, "Email": false} | |
| OptionalSettings | <String> | No | If set will add / update additional settings. ex: OptionalSettings -> {Language": {"CanEdit": true, "Required": false, "Type": "MultipleChoice", "Choices": ["EN", "ES"]}, "Age": {"CanEdit": true, "Required": false, "Type": "TextEntry"} |
Updates an Assessment
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| ThreeSixtyID | <String> | Yes | Will update this assessment. | |
| SurveyID | <String> | No | If supplied, will update the survey for this assessment; deleting the old survey. | |
| WorkFlowOptions | <String> | No | If supplied, will update the workflow options. Only values that are specified will be overwritten. Does not replace entire workflow settings. |
Updates a Person. It's recommended to run updateUser instead of this API to update Email, FirstName and LastName. If you do need to update MetaData, please use updateUser and updatePerson in conjuction to avoid breaking the link between user and person.
| Name | Value(s)/Formatting | Required | Default | Description |
|---|---|---|---|---|
| User | <String> | Yes | The username. | |
| Token | <String> | Yes | API token for the user. | |
| Format | {XML, JSON, JSONP} | Yes | The desired format of the response. | |
| Version | Version number like 'X.X' >= 2.4 | Yes | The version of the API to use. | |
| PersonID | <String> | Yes | The Person to update | |
| FirstName | <String> | No | If supplied, sets the First Name to this value | |
| LastName | <String> | No | If supplied, sets the Last Name to this value | |
| <String> | No | If supplied, sets the Email Address to this value | ||
| MetaData | <String> | No | JSON String of MetaData Key:Values that will be used if included |