Get /micropanel/members/search

Example Request

https://api.questionpro.{{env}}/a/api/v2/micropanel/members/search?filterID={{filter-id}}&page=1&perPage=100

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

To get the filterID, refer the Sample Filter table under the Sampling page. The Sample filter table has a column as ID. This ID is same as filterID.


Authorization

arrow_rightSecurity - API Key
Name : api-key
required
Location : Request Header
Type : string

Request Parameters

arrow_rightPath Parameters
filter-id integer
required
page integer
optional - defalut 1
perPage integer
optional - defalut 100

Example Code

arrow_rightcURL
Snippet copied successfully.
application/json

                curl --request GET \
                --url 'https://api.questionpro.{{env}}/a/api/v2/micropanel/members/search?filterID={{filter-id}}&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/micropanel/members/search?filterID={{filter-id}}&page=1&perPage=100"
                payload={}
            
                headers = {"apiKey":"{{apiKey}}"}
            
                response = requests.request("GET", url, headers=headers, data=payload
            
                print(response.text)   
            
arrow_rightPHP
Snippet copied successfully.
application/json

                <?php
                    $curl = curl_init();
    
                    curl_setopt_array($curl, array(
                    CURLOPT_URL => "https://api.questionpro.{{env}}/a/api/v2/micropanel/members/search?filterID={{filter-id}}&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": [
                            {
                                "panelMemberId": 12345678,
                                "emailAddress": "[email protected]",
                                "firstName": "FirstName",
                                "middleName": "",
                                "lastName": "LastName",
                                "birthday": "1998-08-07",
                                "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": null,
                                "customSource": null,
                                "selectedLanguage": 0,
                                "deviceType": "Unknown",
                                "mobileNumber": "",
                                "username": "",
                                "referID": 0,
                                "custom1": null,
                                "custom2": null,
                                "custom3": null,
                                "custom4": null,
                                "custom5": null,
                                "profileFields": null
                            },
                            {
                                "panelMemberId": 23456781,
                                "emailAddress": "[email protected]",
                                "firstName": "",
                                "middleName": "",
                                "lastName": " ",
                                "birthday": "2000-06-28",
                                "profileCompleteDate": "2023-07-26 18:30:55.0",
                                "zipCode": null,
                                "state": null,
                                "city": null,
                                "address1": null,
                                "address2": null,
                                "status": "Verified",
                                "statusType": 2,
                                "creationDate": "2023-07-26 21:30:55.0",
                                "source": "Qualifying Survey",
                                "lastLoginTimestamp": "2023-07-27T01:36:56.000+00:00",
                                "qPointValue": 120,
                                "unsubscribeDate": null,
                                "customSource": null,
                                "selectedLanguage": 0,
                                "deviceType": "Unknown",
                                "mobileNumber": "",
                                "username": "",
                                "referID": 0,
                                "custom1": null,
                                "custom2": null,
                                "custom3": null,
                                "custom4": null,
                                "custom5": null,
                                "profileFields": null
                            },
                            {
                                "panelMemberId": 13314569,
                                "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": "Verified",
                                "statusType": 2,
                                "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": null,
                                "custom2": null,
                                "custom3": null,
                                "custom4": null,
                                "custom5": null,
                                "profileFields": null
                            }
                                ],
                        "pagination": {
                            "perPage": 100,
                            "totalItems": 3,
                            "currentPage": 1,
                            "totalPages": 1,
                            "links": {
                                "self": "https://api.questionpro.com/a/api/v2/micropanel/members/search?filterID={{filter-id}}&page=1&perPage=100",
                                "prev": null,
                                "next": null,
                                "first": "https://api.questionpro.com/a/api/v2/micropanel/members/search?filterID={{filter-id}}&page=1&perPage=100",
                                "last": "https://api.questionpro.com/a/api/v2/micropanel/members/search?filterID={{filter-id}}&page=1&perPage=100"
                                    }
                                        },
                        "requestID": "00f5c500-5925-4e65-9b34-94a56f7f3260"
                    }
                    
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": {
          "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"
          },
          "custom4": {
            "type": "null"
          },
          "custom1": {
            "type": "null"
          },
          "state": {
            "type": "null"
          },
          "custom2": {
            "type": "null"
          },
          "panelMemberId": {
            "type": "integer"
          },
          "custom5": {
            "type": "null"
          },
          "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",
          "middleName",
          "panelMemberId",
          "status",
          "username"
        ]
      }
    },
    "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"
  ]
}