Get /micropanel/members/search

Example Request

https://{{env}}.questionpro.com/a/api/v2/micropanel/members/search?filterID={{filter-id}}&apiKey={{api_key}}

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

Authorization

arrow_rightKey - apiKey
  • Name: apiKey
  • Location: query

Request Parameters

arrow_rightPath Parameters
filter-id integer
required

Example Code

arrow_rightcURL
application/json

        curl --request GET \
             --url 'https://{{env}}.questionpro.com/a/api/v2/micropanel/members/search?filterID={{filter-id}}&apiKey={{api_key}}'
        
arrow_rightPython
application/json

            import requests

            url = "https://{{env}}.questionpro.com/a/api/v2/micropanel/members/search?filterID={{filter-id}}&apiKey={{api_key}}"
        
            querystring = {"apiKey":"{{apiKey}}"}
        
            response = requests.request("GET", url, params=querystring)
        
            print(response.text)   
            
arrow_rightPHP
application/json

        <?php
                $curl = curl_init();

                curl_setopt_array($curl, array(
                CURLOPT_URL => "https://{{env}}.questionpro.com/a/api/v2/micropanel/members/search?filterID={{filter-id}}&apiKey={{api_key}}";
                CURLOPT_RETURNTRANSFER => true,
                CURLOPT_ENCODING => "",
                CURLOPT_MAXREDIRS => 10,
                CURLOPT_TIMEOUT => 30,
                CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                CURLOPT_CUSTOMREQUEST => "GET",
                ));
            
                $response = curl_exec($curl);
                $err = curl_error($curl);
            
                curl_close($curl);
            
                if ($err) {
                echo "cURL Error # :" . $err;
                } else {
                echo $response;
                }
                ?> 
            

Responses

arrow_rightExample
application/json

       {
    "response": [
        {
            "panelMemberId": 12343123,
            "emailAddress": "[email protected]",
            "firstName": "Test1",
            "middleName": "",
            "lastName": "",
            "birthday": "",
            "profileCompleteDate": "2023-03-31 02:20:24.0",
            "zipCode": null,
            "state": null,
            "city": null,
            "address1": null,
            "address2": null,
            "status": "Verified",
            "statusType": 2,
            "creationDate": "2022-10-27T03:08:32.000+00:00",
            "source": "Upload",
            "lastLoginTimestamp": "2023-04-28T06:32:32.000+00:00",
            "qPointValue": 0,
            "unsubscribeDate": null,
            "customSource": null,
            "selectedLanguage": 0,
            "deviceType": "Unknown",
            "mobileNumber": "",
            "username": "",
            "referID": 0,
            "custom1": "0",
            "custom2": "0",
            "custom3": "",
            "custom4": "",
            "custom5": "",
            "profileFields": null
        },
        {
            "panelMemberId": 23456778,
            "emailAddress": "[email protected]",
            "firstName": "Test2",
            "middleName": "",
            "lastName": "",
            "birthday": "",
            "profileCompleteDate": "2023-03-31 02:15:46.0",
            "zipCode": null,
            "state": null,
            "city": null,
            "address1": null,
            "address2": null,
            "status": "Verified",
            "statusType": 2,
            "creationDate": "2022-07-27T02:15:28.000+00:00",
            "source": "Upload",
            "lastLoginTimestamp": "2022-08-30T10:02:04.000+00:00",
            "qPointValue": 0,
            "unsubscribeDate": null,
            "customSource": "",
            "selectedLanguage": 0,
            "deviceType": "Unknown",
            "mobileNumber": "",
            "username": "",
            "referID": 0,
            "custom1": "0",
            "custom2": "0",
            "custom3": "",
            "custom4": "",
            "custom5": "",
            "profileFields": null
        },
        {
            "panelMemberId": 2301243,
            "emailAddress": "[email protected]",
            "firstName": "Test3",
            "middleName": "",
            "lastName": "Lastname",
            "birthday": "",
            "profileCompleteDate": "2023-03-31 02:19:02.0",
            "zipCode": null,
            "state": null,
            "city": null,
            "address1": null,
            "address2": null,
            "status": "Verified",
            "statusType": 2,
            "creationDate": "2021-07-27T10:18:27.000+00:00",
            "source": "Upload",
            "lastLoginTimestamp": "2023-05-13T00:38:24.000+00:00",
            "qPointValue": 0,
            "unsubscribeDate": null,
            "customSource": "",
            "selectedLanguage": 0,
            "deviceType": "Unknown",
            "mobileNumber": "",
            "username": "",
            "referID": 0,
            "custom1": "0",
            "custom2": "0",
            "custom3": "",
            "custom4": "",
            "custom5": "",
            "profileFields": null
        },
        {
            "panelMemberId": 2500005,
            "emailAddress": "[email protected]",
            "firstName": "Test4",
            "middleName": "",
            "lastName": "Lastname",
            "birthday": "1970-07-11",
            "profileCompleteDate": "2023-03-31 02:17:04.0",
            "zipCode": null,
            "state": null,
            "city": null,
            "address1": null,
            "address2": null,
            "status": "Verified",
            "statusType": 2,
            "creationDate": "2021-07-27T10:18:27.000+00:00",
            "source": "Upload",
            "lastLoginTimestamp": "2023-05-01T08:06:55.000+00:00",
            "qPointValue": 0,
            "unsubscribeDate": null,
            "customSource": "",
            "selectedLanguage": 0,
            "deviceType": "Unknown",
            "mobileNumber": "",
            "username": "",
            "referID": 0,
            "custom1": "0",
            "custom2": "0",
            "custom3": "",
            "custom4": "",
            "custom5": "",
            "profileFields": null
        }
    ],
    "pagination": {
        "perPage": 100,
        "totalItems": 4,
        "currentPage": 1,
        "totalPages": 1,
        "links": {
            "self": "https://www.questionpro.com/a/api/v2/micropanel/members/search?filterID=12980&apiKey={{api_key}}",
            "prev": null,
            "next": null,
            "first": "https://www.questionpro.com/a/api/v2/micropanel/members/search?filterID=12980&page=1&perPage=100&apiKey={{api_key}}",
            "last": "https://www.questionpro.com/a/api/v2/micropanel/members/search?filterID=12980&page=1&perPage=100&apiKey={{api_key}}"
        }
    },
    "requestID": "7a8cdb94-9d5e-4821-8fee-1e1146e857bb"
}
}

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"
  ]
}