API V2
API V2
https://api.questionpro.{{env}}/a/api/v2/micropanel/members/search?status={{memberStatus}}&page=1&perPage=100
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
Refer the below table for the memberStatus values -
| memberStatus | Description |
|---|---|
| 0 | NA |
| 1 | New |
| 2 | Verified |
| 3 | Deleted |
| 4 | Unsubscribed |
| 8 | Email Bounced |
| 16 | Pending Moderator Approval |
| 32 | Blocked/Banned |
| 64 | Pending Sign-Up |
| 128 | Inactive |
| 256 | Spam/Abuse |
curl --location 'https://api.questionpro.{{env}}/a/api/v2/micropanel/members/search?status={{memberStatus}}&page=1&perPage=100'
--header 'api-key': '{{api-key}}' \
import requests
url = "https://api.questionpro.{{env}}/a/api/v2/micropanel/members/search?status={{memberStatus}}&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/micropanel/members/search?status={{memberStatus}}&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": [
{
"panelMemberId": 12345678,
"emailAddress": "[email protected]",
"firstName": "",
"middleName": "",
"lastName": "",
"birthday": "2005-06-27",
"profileCompleteDate": "2023-07-26 12:45:13.0",
"zipCode": null,
"state": null,
"city": null,
"address1": null,
"address2": null,
"status": "Email Bounced",
"statusType": 8,
"creationDate": "2023-07-26 15:45:12.0",
"source": "Qualifying Survey",
"lastLoginTimestamp": "2023-07-27T01:37:27.000+00:00",
"qPointValue": 120,
"unsubscribeDate": null,
"customSource": null,
"selectedLanguage": 0,
"deviceType": "Unknown",
"mobileNumber": "",
"username": "",
"referID": 0,
"custom1": "",
"custom2": "",
"custom3": "",
"custom4": "",
"custom5": "",
"profileFields": null
}
],
"pagination": {
"perPage": 100,
"totalItems": 1,
"currentPage": 1,
"totalPages": 1,
"links": {
"self": "https://api.questionpro.com/a/api/v2/micropanel/members/search?status={{memberStatus}}",
"prev": null,
"next": null,
"first": "https://api.questionpro.com/a/api/v2/micropanel/members/search?status={{memberStatus}}&page=1&perPage=100",
"last": "https://api.questionpro.com/a/api/v2/micropanel/members/search?status={{memberStatus}}&page=1&perPage=100"
}
},
"requestID": "a8a1e1bd-3b72-4354-9c3c-b2070a63cd3f"
}
{
"$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": {
"birthday": {
"type": "string"
},
"lastName": {
"type": "string"
},
"zipCode": {
"type": "null"
},
"selectedLanguage": {
"type": "integer"
},
"statusType": {
"type": "integer"
},
"city": {
"type": "null"
},
"mobileNumber": {
"type": "string"
},
"profileCompleteDate": {
"type": "string"
},
"source": {
"type": "string"
},
"emailAddress": {
"type": "string",
"format": "email"
},
"custom3": {
"type": "string"
},
"custom4": {
"type": "string"
},
"custom1": {
"type": "string"
},
"state": {
"type": "null"
},
"custom2": {
"type": "string"
},
"panelMemberId": {
"type": "integer"
},
"custom5": {
"type": "string"
},
"unsubscribeDate": {
"type": "null"
},
"deviceType": {
"type": "string"
},
"address2": {
"type": "null"
},
"qPointValue": {
"type": "integer"
},
"address1": {
"type": "null"
},
"profileFields": {
"type": "null"
},
"creationDate": {
"type": "string"
},
"lastLoginTimestamp": {
"type": "string"
},
"firstName": {
"type": "string"
},
"referID": {
"type": "integer"
},
"middleName": {
"type": "string"
},
"customSource": {
"type": "null"
},
"status": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"birthday",
"deviceType",
"lastName",
"selectedLanguage",
"statusType",
"qPointValue",
"mobileNumber",
"profileCompleteDate",
"source",
"creationDate",
"lastLoginTimestamp",
"firstName",
"emailAddress",
"referID",
"custom3",
"custom4",
"middleName",
"custom1",
"custom2",
"panelMemberId",
"custom5",
"status",
"username"
]
}
},
"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"
]
}