API V2
API V2
https://api.questionpro.{{env}}/a/api/v2/micropanel/members?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/micropanel/members?page=1&perPage=100' \
--header 'api-key: {{api-key}}' \
import requests
url = "https://api.questionpro.{{env}}/a/api/v2/micropanel/members?page=1&perPage=100"
payload = {}
headers = {
'apiKey': '{{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?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": 16880395,
"emailAddress": "[email protected]",
"firstName": "",
"middleName": "",
"lastName": "",
"birthday": "1996-01-03",
"profileCompleteDate": "2023-09-15 09:11:08.0",
"zipCode": null,
"state": null,
"city": null,
"address1": null,
"address2": null,
"status": "New",
"statusType": 1,
"creationDate": "2023-09-15 12:11:08.0",
"source": "Qualifying Survey",
"lastLoginTimestamp": null,
"qPointValue": 10,
"unsubscribeDate": null,
"customSource": null,
"selectedLanguage": 0,
"deviceType": "Unknown",
"mobileNumber": "",
"username": "",
"referID": 0,
"custom1": null,
"custom2": null,
"custom3": null,
"custom4": null,
"custom5": null,
"profileFields": [
{
"profileFieldId": 223991,
"title": "What kind of pet(s) do you have? Select all that apply",
"fieldType": "Multi Select",
"value": "Dog"
},
{
"profileFieldId": 237317,
"title": "Year of Birth",
"fieldType": "Date/Birthday",
"value": "1996-01-03"
},
{
"profileFieldId": 223979,
"title": "Who do you Identify As",
"fieldType": "Single Select",
"value": "Female"
}
]
},
{
"panelMemberId": 16326143,
"emailAddress": "[email protected]",
"firstName": "",
"middleName": "",
"lastName": "",
"birthday": "1988-03-01",
"profileCompleteDate": "2023-07-28 08:48:46.0",
"zipCode": null,
"state": null,
"city": null,
"address1": null,
"address2": null,
"status": "Verified",
"statusType": 2,
"creationDate": "2023-07-28 11:46:26.0",
"source": "Qualifying Survey",
"lastLoginTimestamp": "2023-09-05T13:20:14.000+00:00",
"qPointValue": 90,
"unsubscribeDate": "2023-11-04T08:01:38.000+00:00",
"customSource": null,
"selectedLanguage": 0,
"deviceType": "Unknown",
"mobileNumber": "",
"username": "",
"referID": 0,
"custom1": "",
"custom2": "",
"custom3": "",
"custom4": "",
"custom5": "",
"profileFields": [
{
"profileFieldId": 223991,
"title": "What kind of pet(s) do you have? Select all that apply",
"fieldType": "Multi Select",
"value": "Dog"
},
{
"profileFieldId": 237317,
"title": "Year of Birth",
"fieldType": "Date/Birthday",
"value": "1988-03-01"
},
{
"profileFieldId": 223979,
"title": "Who do you Identify As",
"fieldType": "Single Select",
"value": "Female"
},
{
"profileFieldId": 238537,
"title": "Country",
"fieldType": "Single Select",
"value": "Mexico"
}
]
},
{
"panelMemberId": 15165155,
"emailAddress": "[email protected]",
"firstName": "",
"middleName": "",
"lastName": "",
"birthday": "1976-05-11",
"profileCompleteDate": "2023-06-29 10:10:00.0",
"zipCode": null,
"state": null,
"city": null,
"address1": null,
"address2": null,
"status": "Verified",
"statusType": 2,
"creationDate": "2023-05-08 08:47:08.0",
"source": "Upload",
"lastLoginTimestamp": "2023-09-06T20:36:02.000+00:00",
"qPointValue": 1004,
"unsubscribeDate": null,
"customSource": null,
"selectedLanguage": 0,
"deviceType": "Unknown",
"mobileNumber": "",
"username": "",
"referID": 0,
"custom1": "",
"custom2": "",
"custom3": "",
"custom4": "",
"custom5": "",
"profileFields": [
{
"profileFieldId": 223991,
"title": "What kind of pet(s) do you have? Select all that apply",
"fieldType": "Multi Select",
"value": "Cat"
},
{
"profileFieldId": 237317,
"title": "Year of Birth",
"fieldType": "Date/Birthday",
"value": "1976-05-11"
},
{
"profileFieldId": 223979,
"title": "Who do you Identify As",
"fieldType": "Single Select",
"value": "Female"
},
{
"profileFieldId": 238537,
"title": "Country",
"fieldType": "Single Select",
"value": "USA"
}
]
}
],
"pagination": {
"perPage": 100,
"totalItems": 3,
"currentPage": 1,
"totalPages": 1,
"links": {
"self": "https://api.questionpro.com/a/api/v2/micropanel/members?page=1&perPage=100",
"prev": null,
"next": null,
"first": "https://api.questionpro.com/a/api/v2/micropanel/members?page=1&perPage=100",
"last": "https://api.questionpro.com/a/api/v2/micropanel/members?page=1&perPage=100"
}
},
"requestID": "c440a23c-a33e-4a1e-abbf-f8440f3e9ebd"
}
{
"$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": [
"null",
"string"
]
},
"custom4": {
"type": [
"null",
"string"
]
},
"custom1": {
"type": [
"null",
"string"
]
},
"state": {
"type": "null"
},
"custom2": {
"type": [
"null",
"string"
]
},
"panelMemberId": {
"type": "integer"
},
"custom5": {
"type": [
"null",
"string"
]
},
"unsubscribeDate": {
"type": [
"null",
"string"
]
},
"deviceType": {
"type": "string"
},
"address2": {
"type": "null"
},
"qPointValue": {
"type": "integer"
},
"address1": {
"type": "null"
},
"profileFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"profileFieldId": {
"type": "integer"
},
"title": {
"type": "string"
},
"fieldType": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"profileFieldId",
"title",
"fieldType",
"value"
]
}
},
"creationDate": {
"type": "string"
},
"lastLoginTimestamp": {
"type": [
"null",
"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",
"profileFields",
"profileCompleteDate",
"source",
"creationDate",
"firstName",
"emailAddress",
"referID",
"middleName",
"panelMemberId",
"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"
]
}