Get /a/api/v2/cx/surveys/{{surveyID}

Example Request

https://api.questionpro.{{env}}/a/api/v2/cx/surveys/{{surveyID}}

The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.


Authorization

arrow_rightSecurity - API Key
Name : api-key
required
Location : Request Header
Type : string

Request Parameters

arrow_rightPath Parameters
feedbackID integer
required
userID integer
required

Responses

arrow_rightExample
application/json

                         {
"response": {
        "surveyID": 10747455,
        "folderID": 5209146,
        "name": "NPS+ Delight Demo",
        "url": "https://questionpro.com/t/AVcXsZwVTx",
        "status": "Active",
        "creationDate": "16 Jan, 2023 01:30:00 PM IST",
        "modifiedDate": "05 Jun, 2023 02:39:17 PM IST",
        "thankYouMessage": "Thank you for completing this survey.",
        "responseQuota": 0,
        "expiryDate": "",
        "inactiveText": "This Survey has been deactivated by the owner.",
        "abbs": false,
        "saveAndContinue": false,
        "surveyFinishMode": 0,
        "completedText": "",
        "terminatedText": "Your profile does not fit our criteria. Thank you for your time.",
        "quotaOverlimitText": "Thank you for your time but we have already received the required responses.",
        "cxFeedbackID": 33203,
        "hasScoringLogic": false,
        "completedResponses": 16,
        "viewedResponses": 20,
        "startedResponses": 16,
        "terminatedResponses": 0,
        "lastResponseReceived": "2023-05-09 02:58:42.0",
        "surveyLanguages": [
            {
                "name": "English",
                "contents": null,
                "default": true
            }
        ]
    },
    "requestID": "98c61cad-81ea-457d-a8b5-26a468b31d92"
}

arrow_rightSchema
application/json
{
  "$schema": "http://json-schema.org/draft-06/schema# ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "viewedResponses": {
          "type": "integer"
        },
        "surveyFinishMode": {
          "type": "integer"
        },
        "inactiveText": {
          "type": "string"
        },
        "startedResponses": {
          "type": "integer"
        },
        "folderID": {
          "type": "integer"
        },
        "expiryDate": {
          "type": "string"
        },
        "terminatedResponses": {
          "type": "integer"
        },
        "responseQuota": {
          "type": "integer"
        },
        "hasScoringLogic": {
          "type": "boolean"
        },
        "saveAndContinue": {
          "type": "boolean"
        },
        "abbs": {
          "type": "boolean"
        },
        "surveyID": {
          "type": "integer"
        },
        "completedText": {
          "type": "string"
        },
        "quotaOverlimitText": {
          "type": "string"
        },
        "thankYouMessage": {
          "type": "string"
        },
        "terminatedText": {
          "type": "string"
        },
        "surveyLanguages": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "default": {
                "type": "boolean"
              },
              "contents": {
                "type": "null"
              },
              "name": {
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "default",
              "name"
            ]
          }
        },
        "creationDate": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "completedResponses": {
          "type": "integer"
        },
        "cxFeedbackID": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "modifiedDate": {
          "type": "string"
        },
        "lastResponseReceived": {
          "type": "string"
        },
        "status": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "viewedResponses",
        "surveyFinishMode",
        "inactiveText",
        "startedResponses",
        "folderID",
        "expiryDate",
        "terminatedResponses",
        "responseQuota",
        "hasScoringLogic",
        "saveAndContinue",
        "abbs",
        "surveyID",
        "completedText",
        "quotaOverlimitText",
        "thankYouMessage",
        "terminatedText",
        "surveyLanguages",
        "creationDate",
        "url",
        "completedResponses",
        "cxFeedbackID",
        "name",
        "modifiedDate",
        "lastResponseReceived",
        "status"
      ]
    },
    "requestID": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "response",
    "requestID"
  ]
}
arrow_right400 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "BAD_REQUEST",
         "httpStatusCode": 400,
         "id" : "1000",
         "message": "Invalid URL parameters",
         "resourceUrl":"resource_url"
        }
    }
}
                                
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
                                
arrow_right401 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "UNAUTHORIZED",
         "httpStatusCode": 401,
         "id" : "1010",
         "message": "Incorrect API Key",
         "resourceUrl":"resource_url"
        }
    }
}
						
							
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
                                
arrow_right403 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "FORBIDDEN",
         "httpStatusCode": 403,
         "id" : "1013",
         "message": "The user does not have permission to access the resource",
         "resourceUrl":"resource_url"
        }
    }
}				
							
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
                                
arrow_right404 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "NOT_FOUND",
         "httpStatusCode": 404,
         "id" : "1040",
         "message": "The resource that you're trying to access doesn't exist",
         "resourceUrl":"resource_url"
        }
    }
}
							
							
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
                                
arrow_right500 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "INTERNAL_SERVER_ERROR",
         "httpStatusCode": 500,
         "id" : "1026",
         "message": "We are not able to process your request",
         "resourceUrl":"resource_url"
        }
    }
}
							
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}