API V2
API V2
https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails?page=1&perPage=100
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
curl --location 'https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails?page=1&perPage=100' \
--header 'api-key: {{api-key}}' \
import requests
url = "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails?page=1&perPage=100"
payload = {}
headers = {
'api-key': '{{api-key}}'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
<?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}}/emails?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;
{
"response": [
{
"addressID": 100000012,
"emailAddress": "[email protected]",
"firstname": "",
"lastname": "",
"address1": "",
"address2": "",
"city": "",
"state": "",
"phone": "",
"zipcode": "",
"emailListID": 1234567,
"custom1": "Employee 7",
"custom2": "Security",
"custom3": "Product R",
"custom4": "",
"custom5": "",
"creationDate": "Thu 31 Oct, 17:24:36 GMT 2019",
"highCustomVariables": {}
},
{
"addressID": 100000012,
"emailAddress": "[email protected]",
"firstname": "",
"lastname": "",
"address1": "",
"address2": "",
"city": "",
"state": "",
"phone": "",
"zipcode": "",
"emailListID": 1234567,
"custom1": "Employee 6",
"custom2": "Support",
"custom3": "Product Z",
"custom4": "",
"custom5": "",
"creationDate": "Thu 31 Oct, 17:24:36 GMT 2019",
"highCustomVariables": {}
}
],
"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}}/emails?page=1&perPage=100",
"prev": null,
"next": "",
"first": "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails?page=1&perPage=100",
"last": "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails?page=1&perPage=100"
}
},
"requestID": "2012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
}
{
"$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": "string"
},
"last": {
"type": "string"
},
"prev": {
"type": "null"
},
"self": {
"type": "string"
},
"first": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"next",
"last",
"self",
"first"
]
},
"currentPage": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"totalItems",
"perPage",
"totalPages",
"links",
"currentPage"
]
},
"response": {
"type": "array",
"items": {
"type": "object",
"properties": {
"firstname": {
"type": "string"
},
"address2": {
"type": "string"
},
"city": {
"type": "string"
},
"address1": {
"type": "string"
},
"highCustomVariables": {
"type": "object",
"additionalProperties": false
},
"creationDate": {
"type": "string"
},
"emailListID": {
"type": "integer"
},
"addressID": {
"type": "integer"
},
"lastname": {
"type": "string"
},
"zipcode": {
"type": "string"
},
"emailAddress": {
"type": "string",
"format": "email"
},
"phone": {
"type": "string"
},
"custom3": {
"type": "string"
},
"custom4": {
"type": "string"
},
"custom1": {
"type": "string"
},
"state": {
"type": "string"
},
"custom2": {
"type": "string"
},
"custom5": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"firstname",
"address2",
"city",
"address1",
"highCustomVariables",
"creationDate",
"emailListID",
"addressID",
"lastname",
"zipcode",
"emailAddress",
"phone",
"custom3",
"custom4",
"custom1",
"state",
"custom2",
"custom5"
]
}
},
"requestID": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"pagination",
"response",
"requestID"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "BAD_REQUEST",
"httpStatusCode": 400,
"id" : "1000",
"message": "Invalid URL parameters",
"resourceUrl":"resource_url"
}
}
}
{
"$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"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "UNAUTHORIZED",
"httpStatusCode": 401,
"id" : "1010",
"message": "Incorrect API Key",
"resourceUrl":"resource_url"
}
}
}
{
"$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"
]
}
{
"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"
}
}
}
{
"$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"
]
}
{
"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"
}
}
}
{
"$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"
]
}
{
"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"
}
}
}
{
"$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"
]
}