Qualtrics

Qualtrics Survey Definitions API

The Survey Definitions API from Qualtrics — 2 operation(s) for survey definitions.

GitHub OpenAPI

Documentation

📖
Documentation
https://api.qualtrics.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/qualtrics/refs/heads/main/openapi/qualtrics-survey-definitions-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/qualtrics/refs/heads/main/json-schema/surveyresponse.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/qualtrics/refs/heads/main/json-schema/distributionsresponse.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/qualtrics/refs/heads/main/json-schema/retrievedistributionlinksresponse.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/qualtrics/refs/heads/main/json-schema/eventsubscriptionsresponse.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/qualtrics/refs/heads/main/json-schema/eventsubscriptionhookschema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/qualtrics/refs/heads/main/json-schema/createdistributionlinks.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/qualtrics/refs/heads/main/json-schema/createcontactinmailinglist.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/qualtrics/refs/heads/main/json-schema/subscribetoeventbody.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/qualtrics/refs/heads/main/examples/qualtrics-api-examples.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/qualtrics/refs/heads/main/vocabulary/qualtrics-api-vocabulary.json
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/qualtrics/refs/heads/main/json-ld/qualtrics-api-context.jsonld
🔗
Postman
https://www.postman.com/qualtrics-public-apis/qualtrics-public-workspace/documentation/e4q8a25/qualtrics-rest-api

OpenAPI Specification

qualtrics-survey-definitions-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  version: '0.2'
  title: Qualtrics automations Survey Definitions API
  description: Work with Qualtrics surveys, distributions and response events
servers:
- url: https://{apiRegion}.qualtrics.com/API/{apiVersion}
  description: Qualtrics API endpoint for EU region
  variables:
    apiRegion:
      default: fra1
      description: Specify the Qualtrics datacenter prefix according to your account (find it at <your URL>/Q/QualtricsIdsSection/IdsSection)
    apiVersion:
      default: v3
      description: API version to use - default v3
security:
- QualtricsAPIKeyAuth: []
tags:
- name: Survey Definitions
paths:
  /survey-definitions/{Id}:
    get:
      summary: Get a specific survey by its 'id' (e.g SV_123)
      operationId: Getsurveys
      parameters:
      - name: Id
        in: path
        required: true
        schema:
          type: string
        example: SV_123
      responses:
        '200':
          description: The requested survey
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SurveyResponse'
      tags:
      - Survey Definitions
  /survey-definitions/{SurveyId}:
    get:
      summary: Get survey
      description: Gets a single Qualtrics survey speficied by its ID
      operationId: GetSurvey
      parameters:
      - name: SurveyId
        x-ms-summary: Survey ID
        in: path
        required: true
        type: string
        description: ID of survey (eg. SV_123)
      responses:
        '200':
          description: Survey data
          headers: {}
          schema:
            $ref: '#/definitions/SurveyResponse'
        default:
          description: Operation Failed.
      tags:
      - Survey Definitions
components:
  schemas:
    SurveyResponse:
      type: object
      properties:
        result:
          type: object
          properties:
            QuestionCount:
              type: string
            SurveyOptions:
              type: object
              properties:
                ActiveResponseSet:
                  type: string
                AnonymizeResponse:
                  type: string
                Autoadvance:
                  type: string
                AutoadvancePages:
                  type: string
                Autofocus:
                  type: string
                AvailableLanguages:
                  type: object
                  properties:
                    EN:
                      type: array
                BackButton:
                  type: string
                BallotBoxStuffingPrevention:
                  type: string
                CollectGeoLocation:
                  type: string
                CustomStyles:
                  type: object
                  properties:
                    altRowStyles:
                      type: object
                      properties:
                        selector:
                          type: string
                        styles:
                          type: object
                          properties:
                            backgroundColor: {}
                    borderStyles:
                      type: object
                      properties:
                        selector:
                          type: string
                        styles:
                          type: object
                          properties:
                            borderColor: {}
                    choiceStyles:
                      type: object
                      properties:
                        selector:
                          type: string
                        styles:
                          type: object
                          properties:
                            color: {}
                            fontFamily: {}
                            fontSize: {}
                            fontStyle: {}
                            fontWeight: {}
                            textDecoration: {}
                    customCSS: {}
                    errorStyles:
                      type: object
                      properties:
                        selector:
                          type: string
                        styles:
                          type: object
                          properties:
                            backgroundColor: {}
                            borderColor: {}
                            color: {}
                    errorStylesBG:
                      type: object
                      properties:
                        selector:
                          type: string
                        styles:
                          type: object
                          properties:
                            backgroundColor: {}
                            color: {}
                    footerStyles:
                      type: object
                      properties:
                        selector:
                          type: string
                        styles:
                          type: object
                          properties:
                            color: {}
                    headerStyles:
                      type: object
                      properties:
                        selector:
                          type: string
                        styles:
                          type: object
                          properties:
                            color: {}
                    highlightStyles:
                      type: object
                      properties:
                        selector:
                          type: string
                        styles:
                          type: object
                          properties:
                            backgroundColor: {}
                    highlightStylesAlt:
                      type: object
                      properties:
                        selector:
                          type: string
                        styles:
                          type: object
                          properties:
                            backgroundColor: {}
                    pageStyles:
                      type: object
                      properties:
                        selector:
                          type: string
                        styles:
                          type: object
                          properties:
                            backgroundColor: {}
                    questionSeparatorStyles:
                      type: object
                      properties:
                        selector:
                          type: string
                        styles:
                          type: object
                          properties:
                            backgroundColor: {}
                            display: {}
                    questionStyles:
                      type: object
                      properties:
                        selector:
                          type: string
                        styles:
                          type: object
                          properties:
                            color: {}
                            fontFamily: {}
                            fontSize: {}
                            fontStyle: {}
                            fontWeight: {}
                            textDecoration: {}
                    textEntryStyles:
                      type: object
                      properties:
                        selector:
                          type: string
                        styles:
                          type: object
                          properties:
                            color: {}
                    textStyles:
                      type: object
                      properties:
                        selector:
                          type: string
                        styles:
                          type: object
                          properties:
                            color: {}
                            fontFamily: {}
                            fontSize: {}
                            fontStyle: {}
                            fontWeight: {}
                            textDecoration: {}
                EOSMessage:
                  type: string
                EOSMessageLibrary:
                  type: string
                EOSRedirectURL:
                  type: string
                EmailThankYou:
                  type: string
                ExternalCSS: {}
                Footer:
                  type: string
                Header:
                  type: string
                HighlightQuestions:
                  type: string
                InactiveMessage:
                  type: string
                InactiveMessageLibrary:
                  type: string
                InactiveSurvey:
                  type: string
                NewScoring:
                  type: integer
                NextButton:
                  type: string
                NoIndex:
                  type: string
                PageTransition:
                  type: string
                PartialData:
                  type: string
                PartialDataCloseAfter:
                  type: string
                Password:
                  type: string
                PasswordProtection:
                  type: string
                PreviousButton:
                  type: string
                ProgressBarDisplay:
                  type: string
                ProtectSelectionIds:
                  type: boolean
                QuestionsPerPage:
                  type: string
                RecaptchaV3:
                  type: string
                RefererCheck:
                  type: string
                RefererURL:
                  type: string
                RelevantID:
                  type: string
                ResponseSummary:
                  type: string
                SaveAndContinue:
                  type: string
                SecureResponseFiles:
                  type: string
                ShowExportTags:
                  type: string
                Skin:
                  type: string
                SkinLibrary:
                  type: string
                SkinType:
                  type: string
                SurveyExpiration: {}
                SurveyMetaDescription:
                  type: string
                SurveyName:
                  type: string
                SurveyProtection:
                  type: string
                SurveyTermination:
                  type: string
                SurveyTitle:
                  type: string
                ThankYouEmailMessage: {}
                ThankYouEmailMessageLibrary: {}
                ValidateMessage:
                  type: string
                ValidationMessage: {}
                ValidationMessageLibrary: {}
                footerMid:
                  type: string
                headerMid:
                  type: string
                libraryId:
                  type: string
                nextButtonMid:
                  type: string
                previousButtonMid:
                  type: string
                SkinQuestionWidth:
                  type: integer
                SurveyLanguage:
                  type: string
                SurveyStartDate: {}
                SurveyExpirationDate: {}
                SurveyCreationDate:
                  type: string
            SurveyID:
              type: string
            SurveyName:
              type: string
            SurveyStatus:
              type: string
            LastModified:
              type: string
            BrandID:
              type: string
            OwnerID:
              type: string
            LastAccessed: {}
            CreatorID:
              type: string
            LastActivated:
              type: string
            Questions:
              type: object
              properties:
                QID46:
                  type: object
                  properties:
                    ChoiceOrder:
                      type: array
                      items:
                        type: string
                    Choices:
                      type: object
                      properties:
                        '1':
                          type: object
                          properties:
                            Display:
                              type: string
                        '2':
                          type: object
                          properties:
                            Display:
                              type: string
                        '3':
                          type: object
                          properties:
                            Display:
                              type: string
                        '4':
                          type: object
                          properties:
                            Display:
                              type: string
                        '5':
                          type: object
                          properties:
                            Display:
                              type: string
                    Configuration:
                      type: object
                      properties:
                        QuestionDescriptionOption:
                          type: string
                        TextPosition:
                          type: string
                    DataExportTag:
                      type: string
                    DataVisibility:
                      type: object
                      properties:
                        Hidden:
                          type: boolean
                        Private:
                          type: boolean
                    DefaultChoices:
                      type: boolean
                    GradingData:
                      type: array
                    Language:
                      type: array
                    NextAnswerId:
                      type: integer
                    NextChoiceId:
                      type: integer
                    QuestionDescription:
                      type: string
                    QuestionID:
                      type: string
                    QuestionText:
                      type: string
                    QuestionType:
                      type: string
                    Selector:
                      type: string
                    SubSelector:
                      type: string
                    Validation:
                      type: object
                      properties:
                        Settings:
                          type: object
                          properties:
                            ForceResponse:
                              type: string
                            ForceResponseType:
                              type: string
                            Type:
                              type: string
                    QuestionText_Unsafe:
                      type: string
                QID48:
                  type: object
                  properties:
                    ChoiceOrder:
                      type: array
                      items:
                        type: string
                    Choices:
                      type: object
                      properties:
                        '1':
                          type: object
                          properties:
                            Display:
                              type: string
                        '2':
                          type: object
                          properties:
                            Display:
                              type: string
                        '3':
                          type: object
                          properties:
                            Display:
                              type: string
                        '4':
                          type: object
                          properties:
                            Display:
                              type: string
                        '5':
                          type: object
                          properties:
                            Display:
                              type: string
                    Configuration:
                      type: object
                      properties:
                        QuestionDescriptionOption:
                          type: string
                        TextPosition:
                          type: string
                    DataExportTag:
                      type: string
                    DataVisibility:
                      type: object
                      properties:
                        Hidden:
                          type: boolean
                        Private:
                          type: boolean
                    DefaultChoices:
                      type: boolean
                    GradingData:
                      type: array
                    Language:
                      type: array
                    NextAnswerId:
                      type: integer
                    NextChoiceId:
                      type: integer
                    QuestionDescription:
                      type: string
                    QuestionID:
                      type: string
                    QuestionText:
                      type: string
                    QuestionType:
                      type: string
                    Selector:
                      type: string
                    SubSelector:
                      type: string
                    Validation:
                      type: object
                      properties:
                        Settings:
                          type: object
                          properties:
                            ForceResponse:
                              type: string
                            ForceResponseType:
                              type: string
                            Type:
                              type: string
                    QuestionText_Unsafe:
                      type: string
                QID50:
                  type: object
                  properties:
                    ChoiceOrder:
                      type: array
                      items:
                        type: string
                    Choices:
                      type: object
                      properties:
                        '1':
                          type: object
                          properties:
                            Display:
                              type: string
                        '2':
                          type: object
                          properties:
                            Display:
                              type: string
                        '3':
                          type: object
                          properties:
                            Display:
                              type: string
                        '4':
                          type: object
                          properties:
                            Display:
                              type: string
                        '5':
                          type: object
                          properties:
                            Display:
                              type: string
                    Configuration:
                      type: object
                      properties:
                        QuestionDescriptionOption:
                          type: string
                        TextPosition:
                          type: string
                    DataExportTag:
                      type: string
                    DataVisibility:
                      type: object
                      properties:
                        Hidden:
                          type: boolean
                        Private:
                          type: boolean
                    DefaultChoices:
                      type: boolean
                    GradingData:
                      type: array
                    Language:
                      type: array
                    NextAnswerId:
                      type: integer
                    NextChoiceId:
                      type: integer
                    QuestionDescription:
                      type: string
                    QuestionID:
                      type: string
                    QuestionText:
                      type: string
                    QuestionType:
                      type: string
                    Selector:
                      type: string
                    SubSelector:
                      type: string
                    Validation:
                      type: object
                      properties:
                        Settings:
                          type: object
                          properties:
                            ForceResponse:
                              type: string
                            ForceResponseType:
                              type: string
                            Type:
                              type: string
                    QuestionText_Unsafe:
                      type: string
                QID52:
                  type: object
                  properties:
                    ChoiceOrder:
                      type: array
                      items:
                        type: string
                    Choices:
                      type: object
                      properties:
                        '1':
                          type: object
                          properties:
                            Display:
                              type: string
                        '2':
                          type: object
                          properties:
                            Display:
                              type: string
                        '3':
                          type: object
                          properties:
                            Display:
                              type: string
                        '4':
                          type: object
                          properties:
                            Display:
                              type: string
                        '5':
                          type: object
                          properties:
                            Display:
                              type: string
                    Configuration:
                      type: object
                      properties:
                        QuestionDescriptionOption:
                          type: string
                        TextPosition:
                          type: string
                    DataExportTag:
                      type: string
                    DataVisibility:
                      type: object
                      properties:
                        Hidden:
                          type: boolean
                        Private:
                          type: boolean
                    DefaultChoices:
                      type: boolean
                    GradingData:
                      type: array
                    Language:
                      type: array
                    NextAnswerId:
                      type: integer
                    NextChoiceId:
                      type: integer
                    QuestionDescription:
                      type: string
                    QuestionID:
                      type: string
                    QuestionText:
                      type: string
                    QuestionType:
                      type: string
                    Selector:
                      type: string
                    SubSelector:
                      type: string
                    Validation:
                      type: object
                      properties:
                        Settings:
                          type: object
                          properties:
                            ForceResponse:
                              type: string
                            ForceResponseType:
                              type: string
                            Type:
                              type: string
                    QuestionText_Unsafe:
                      type: string
                QID54:
                  type: object
                  properties:
                    ChoiceOrder:
                      type: array
                      items:
                        type: string
                    Choices:
                      type: object
                      properties:
                        '1':
                          type: object
                          properties:
                            Display:
                              type: string
                        '2':
                          type: object
                          properties:
                            Display:
                              type: string
                        '3':
                          type: object
                          properties:
                            Display:
                              type: string
                        '4':
                          type: object
                          properties:
                            Display:
                              type: string
                        '5':
                          type: object
                          properties:
                            Display:
                              type: string
                    Configuration:
                      type: object
                      properties:
                        QuestionDescriptionOption:
                          type: string
                        TextPosition:
                          type: string
                    DataExportTag:
                      type: string
                    DataVisibility:
                      type: object
                      properties:
                        Hidden:
                          type: boolean
                        Private:
                          type: boolean
                    DefaultChoices:
                      type: boolean
                    GradingData:
                      type: array
                    Language:
                      type: array
                    NextAnswerId:
                      type: integer
                    NextChoiceId:
                      type: integer
                    QuestionDescription:
                      type: string
                    QuestionID:
                      type: string
                    QuestionText:
                      type: string
                    QuestionType:
                      type: string
                    Selector:
                      type: string
                    SubSelector:
                      type: string
                    Validation:
                      type: object
                      properties:
                        Settings:
                          type: object
                          properties:
                            ForceResponse:
                              type: string
                            ForceResponseType:
                              type: string
                            Type:
                              type: string
                    QuestionText_Unsafe:
                      type: string
                QID45:
                  type: object
                  properties:
                    ChoiceOrder:
                      type: array
                      items:
                        type: string
                    Choices:
                      type: object
                      properties:
                        '1':
                          type: object
                          properties:
                            Display:
                              type: string
                        '2':
                          type: object
                          properties:
                            Display:
                              type: string
                        '3':
                          type: object
                          properties:
                            Display:
                              type: string
                        '4':
                          type: object
                          properties:
                            Display:
                              type: string
                        '5':
                          type: object
                          properties:
                            Display:
                              type: string
                    Configuration:
                      type: object
                      properties:
                        QuestionDescriptionOption:
                          type: string
                        TextPosition:
                          type: string
                    DataExportTag:
                      type: string
                    DataVisibility:
                      type: object
                      properties:
                        Hidden:
                          type: boolean
                        Private:
                          type: boolean
                    DefaultChoices:
                      type: boolean
                    GradingData:
                      type: array
                    Language:
                      type: array
                    NextAnswerId:
                      type: integer
                    NextChoiceId:
                      type: integer
                    QuestionDescription:
                      type: string
                    QuestionID:
                      type: string
                    QuestionText:
                      type: string
                    QuestionType:
                      type: string
                    Selector:
                      type: string
                    SubSelector:
                      type: string
                    Validation:
                      type: object
                      properties:
                        Settings:
                          type: object
                          properties:
                            ForceResponse:
                              type: string
                            ForceResponseType:
                              type: string
                            Type:
                              type: string
                    QuestionText_Unsafe:
                      type: string
                QID47:
                  type: object
                  properties:
                    ChoiceOrder:
                      type: array
                      items:
                        type: string
                    Choices:
                      type: object
                      properties:
                        '1':
                          type: object
                          properties:
                            Display:
                              type: string
                        '2':
                          type: object
                          properties:
                            Display:
                              type: string
                        '3':
                          type: object
                          properties:
                            Display:
                              type: string
                        '4':
                          type: object
                          properties:
                            Display:
                              type: string
                        '5':
                          type: object
                          properties:
                            Display:
                              type: string
                    Configuration:
                      type: object
                      properties:
                        QuestionDescriptionOption:
                          type: string
                        TextPosition:
                          type: string
                    DataExportTag:
                      type: string
                    DataVisibility:
                      type: object
                      properties:
                        Hidden:
                          type: boolean
                        Private:
                          type: boolean
                    DefaultChoices:
                      type: boolean
                   

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qualtrics/refs/heads/main/openapi/qualtrics-survey-definitions-api-openapi.yml