Get /surveys/{{survey-id}}/emaillists/{{email-list-id}}/exportbatch

Example Request

https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/exportbatch?page=1&perPage=100

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
survey-id integer
required
email-list-id integer
required
page integer
optional - defalut 1
perPage integer
optional - defalut 100

Example Code

arrow_rightcURL
Snippet copied successfully.
application/json

curl --location 'https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/exportbatch?page=1&perPage=100' \
--header 'api-key: {{api-key}}'
                
arrow_rightPython
Snippet copied successfully.
application/json

import requests

url = "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/exportbatch?page=1&perPage=100"

payload = {}
headers = {
  'api-key': '{{api-key}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

                    
arrow_rightPHP - cURL
Snippet copied successfully.
application/json

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/exportbatch?page=1&perPage=100',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'api-key: {{api-key}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

                    

Responses

arrow_rightExample
application/json

                        {
                            "response":  [
                                {
                                    "addressID": 123456789,
                                    "emailAddress": "[email protected]",
                                    "uniqueSurveyUrl": "https://www.questionpro.com/a/TakeSurvey?tt=JQHd0RlCP0983blCQB9%2BNMKIFoBOpt2x",
                                    "firstname": "Second",
                                    "lastname": "Email",
                                    "emailListID": 8000001,
                                    "custom1": "WA",
                                    "custom2": "Sales",
                                    "custom3": "987987",
                                    "custom4": "Work",
                                    "custom5": "",
                                    "creationDate": "Fri 04 Oct, 08:50:24 GMT 2020",
                                    "highCustomVariables": {                                     
                                        "custom6": "Additional",
                                        "custom7": "Information",
                                        "custom8": "About Respondent"
                                    }
                                },
                                {
                                    "addressID": 123456788,
                                    "emailAddress": "[email protected]",
                                    "uniqueSurveyUrl": "https://www.questionpro.com/a/TakeSurvey?tt=JQHd0RlCP0983blQB9%2BNHtMHws332I/",
                                    "firstname": "First",
                                    "lastname": "Email",
                                    "emailListID": 8000001,
                                    "custom1": "WA",
                                    "custom2": "Sales",
                                    "custom3": "987987",
                                    "custom4": "Work",
                                    "custom5": "",
                                    "creationDate": "Fri 04 Oct, 08:50:24 GMT 2020",
                                    "highCustomVariables":  {                                     
                                        "custom12": "Additional",
                                        "custom13": "Information",
                                        "custom15": "About Respondent"
                                    }
                                }
                           ],
                           "pagination": {
                                "perPage": 100,
                                "totalItems": 2,
                                "currentPage": 1,
                                "totalPages": 1,
                                "links": {
                                    "self": "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/exportbatch?page=1&perPage=100",
                                    "prev": null,
                                    "next": null,
                                    "first": "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/exportbatch?page=1&perPage=100",
                                    "last": "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/exportbatch?page=1&perPage=100"
                                }
                            },
                            "requestID": "6012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
                         
                        }
                    
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": {
          "firstname": {
            "type": "string"
          },
          "highCustomVariables": {
            "type": "object",
            "properties": {
              "custom13": {
                "type": "string"
              },
              "custom12": {
                "type": "string"
              },
              "custom15": {
                "type": "string"
              },
              "custom7": {
                "type": "string"
              },
              "custom8": {
                "type": "string"
              },
              "custom6": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "creationDate": {
            "type": "string"
          },
          "emailListID": {
            "type": "integer"
          },
          "addressID": {
            "type": "integer"
          },
          "lastname": {
            "type": "string"
          },
          "emailAddress": {
            "type": "string",
            "format": "email"
          },
          "custom3": {
            "type": "string"
          },
          "custom4": {
            "type": "string"
          },
          "uniqueSurveyUrl": {
            "type": "string"
          },
          "custom1": {
            "type": "string"
          },
          "custom2": {
            "type": "string"
          },
          "custom5": {
            "type": "string"
          }
        },
        "additionalProperties": false,
        "required": [
          "firstname",
          "highCustomVariables",
          "creationDate",
          "emailListID",
          "addressID",
          "lastname",
          "emailAddress",
          "custom3",
          "custom4",
          "uniqueSurveyUrl",
          "custom1",
          "custom2",
          "custom5"
        ]
      }
    },
    "requestID": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "pagination",
    "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"
  ]
}