Get micropanel/members/search?emailAddress={email}

Example Request

https://api.questionpro.{{env}}/a/api/v2/micropanel/members/search?emailAddress={{email}}

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


Authorization

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

Request Parameters

arrow_rightPath Parameters
emailID email
required

Responses

arrow_rightExample
application/json

                         {
"response": 
       {
           
       "panelMemberId":1234,
       "emailAddress": "[email protected]",
       "firstName": "",
       "middleName": null,
       "lastName": "",
       "birthday": "",
       "profileCompleteDate": "",
       "zipCode": null,
       "city": null,
       "address1": null,
       "address2": null,
       "status": "New",
       "statusType": 1,
       "creationDate": "2022-07-18T14:59:15.000+00:00",
       "source": "Web",
       "lastLoginTimestamp": null,
       "qPointValue": 0,
       "unsubscribeDate": null,
       "moderator": 0,
       "customSource": null,
       "selectedLanguage": 0,
       "deviceType": "Unknown",
       "mobileNumber": "",
       "username": null,
       "referID": 0,
       "custom1": null,
       "custom2": null,
       "custom3": null,
       "custom4": null,
       "custom5": null,
       "profileFields": null
   },
   "requestID": "4012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
}


arrow_rightSchema
application/json
{
  "$schema": "http://json-schema.org/draft-06/schema# ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "birthday": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "zipCode": {
          "type": "null"
        },
        "selectedLanguage": {
          "type": "integer"
        },
        "statusType": {
          "type": "integer"
        },
        "city": {
          "type": "null"
        },
        "mobileNumber": {
          "type": "string"
        },
        "moderator": {
          "type": "integer"
        },
        "profileCompleteDate": {
          "type": "string"
        },
        "source": {
          "type": "string"
        },
        "emailAddress": {
          "type": "string",
          "format": "email"
        },
        "custom3": {
          "type": "null"
        },
        "custom4": {
          "type": "null"
        },
        "custom1": {
          "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": "null"
        },
        "firstName": {
          "type": "string"
        },
        "referID": {
          "type": "integer"
        },
        "middleName": {
          "type": "null"
        },
        "customSource": {
          "type": "null"
        },
        "status": {
          "type": "string"
        },
        "username": {
          "type": "null"
        }
      },
      "additionalProperties": false,
      "required": [
        "birthday",
        "deviceType",
        "lastName",
        "selectedLanguage",
        "statusType",
        "qPointValue",
        "mobileNumber",
        "moderator",
        "profileCompleteDate",
        "source",
        "creationDate",
        "firstName",
        "emailAddress",
        "referID",
        "panelMemberId",
        "status"
      ]
    },
    "requestID": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "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"
  ]
}