Get /surveys/{{survey-id}}/questions

Example Request

https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/questions?page=1&perPage=100&apiKey={{apiKey}}

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

Authorization

arrow_rightKey - apiKey
  • Name: apiKey
  • Location: query

Request Parameters

arrow_rightPath Parameters
survey-id integer
required
page integer
defalut 1
perPage integer
defalut 100

Example Code

arrow_rightcURL
application/json

                                curl --request GET \
                                --url 'https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/questions?page=1&perPage=100&apiKey={{apiKey}}'
                        
arrow_rightPython
application/json

                                import requests

                                url = "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/questions"
                            
                                querystring = {"page":"1","perPage":"100","apiKey":"{{apiKey}}"}
                            
                                response = requests.request("GET", url, params=querystring)
                            
                                print(response.text)

                            
arrow_rightPHP
application/json

                               <?php
                                               $curl = curl_init();
                                               curl_setopt_array($curl, array(
                                               CURLOPT_URL =>
                                                  "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/questions?page=1&perPage=100&apiKey={{apiKey}}",
                                                    CURLOPT_RETURNTRANSFER => true,
                                                    CURLOPT_ENCODING => "",
                                                    CURLOPT_MAXREDIRS => 10,
                                                    CURLOPT_TIMEOUT => 30,
                                                    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                                                    CURLOPT_CUSTOMREQUEST => "GET",
                                                    ));
                                                
                                                    $response = curl_exec($curl);
                                                    $err = curl_error($curl);
                                                
                                                    curl_close($curl);
                                                
                                                    if ($err) {
                                                    echo "cURL Error # :" . $err;
                                                    } else {
                                                    echo $response;
                                                    }
                                                    ?>

                            

Responses

arrow_rightExample
application/json

                                                        {
                                "response": [
                                    {
                                        "questionID": 86055471,
                                        "blockID": 123456,
                                        "type": "multiplechoice_radio",
                                        "text": "Please select your gender",
                                        "code": "Q1",
                                        "orderNumber": 1,
                                        "required": true,
                                        "answers": [
                                            {
                                                "answerID": 462043572,
                                                "text": "Male",
                                                "excludeRandomization": false
                                            },
                                            {
                                                "answerID": 462043573,
                                                "text": "Female",
                                                "excludeRandomization": false
                                            }
                                        ]
                                    }
                                ],
                                "pagination": {
                                    "perPage": 100,
                                    "totalItems": 1,
                                    "currentPage": 1,
                                    "totalPages": 1,
                                    "links": {
                                        "self": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/questions?page=1&perPage=100&apiKey={{apiKey}}",
                                        "prev": null,
                                        "next": null,
                                        "first": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/questions?page=1&perPage=100&apiKey=apiKey={{apiKey}}",
                                        "last": "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/questions?page=1&perPage=100&apiKey=apiKey={{apiKey}}"
                                    }
                                }
                            }
                         
                    
arrow_rightSchema
application/json
{
  "$schema": "http://json-schema.org/draft-06/schema# ",
  "type": "object",
  "properties": {
    "pagination": {
      "type": "object",
      "properties": {
        "totalItems": {
          "type": "integer"
        },
        "perPage": {
          "type": "integer"
        },
        "totalPages": {
          "type": "integer"
        },
        "links": {
          "type": "object",
          "properties": {
            "next": {
              "type": "null"
            },
            "last": {
              "type": "string"
            },
            "prev": {
              "type": "null"
            },
            "self": {
              "type": "string"
            },
            "first": {
              "type": "string"
            }
          },
          "additionalProperties": false,
          "required": [
            "last",
            "self",
            "first"
          ]
        },
        "currentPage": {
          "type": "integer"
        }
      },
      "additionalProperties": false,
      "required": [
        "totalItems",
        "perPage",
        "totalPages",
        "links",
        "currentPage"
      ]
    },
    "response": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blockID": {
            "type": "integer"
          },
          "questionID": {
            "type": "integer"
          },
          "code": {
            "type": "string"
          },
          "orderNumber": {
            "type": "integer"
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "answerID": {
                  "type": "integer"
                },
                "excludeRandomization": {
                  "type": "boolean"
                },
                "text": {
                  "type": "string"
                }
              },
              "additionalProperties": false,
              "required": [
                "answerID",
                "excludeRandomization",
                "text"
              ]
            }
          },
          "text": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "required": {
            "type": "boolean"
          }
        },
        "additionalProperties": false,
        "required": [
          "blockID",
          "questionID",
          "code",
          "orderNumber",
          "answers",
          "text",
          "type",
          "required"
        ]
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "pagination",
    "response"
  ]
}
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"
  ]
}