Get /micropanel/members

Example Request

https://api.questionpro.{{env}}/a/api/v2/micropanel/members

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 Body

arrow_rightPayload
application/json

            [
    {
        "emailAddress": "[email protected]",
        "firstName": "ABC",
        "middleName": "E",
        "lastName": "CDF",
        "source": "Panel API",
        "mobileNumber": "+91-9998887766",
        "username": "abctest1",
        "custom1": "",
        "custom2": "",
        "custom3": "",
        "custom4": "",
        "custom5": "",
        "password": "Test@123",
        "profileFields": []
    },
        {
        "emailAddress": "[email protected]",
        "firstName": "ABC",
        "middleName": "E",
        "lastName": "CDF",
        "source": "Panel API",
        "mobileNumber": "+91-9998887765",
        "username": "abctest2",
        "custom1": "",
        "custom2": "",
        "custom3": "",
        "custom4": "",
        "custom5": "",
        "password": "Test@123",
        "profileFields": [
            {////This is for single row text similarly this can be use for large text
                "profileFieldId": 2178,
                "value": "Single Row Value"
            },
            {////Single select option
                "profileFieldId": 577,
                "value": "881"
            },
            {///multiselect option
                "profileFieldId": 578,
                "value": [885,887]
            },
            {////birthdate
                "profileFieldId": 547,
                "value": "1991-01-01"
            },
            {///Germany zipcode, similarly it can be use for other zipcode
                "profileFieldId": 2680,
                "value": "82435"
            },
            {///Numberic value
                "profileFieldId": 576,
                "value": "1234"
            },
            {///Address field
                "profileFieldId": 609,
                "value": {
                    "address1": "Address 1",
                    "address2": "ABC Road",
                    "city": "ABC",
                    "state": "MH",
                    "country": "India"
                }
            }
        ]
    }
]
        

Example Code

arrow_rightcURL
application/json

        curl --location 'https://api.questionpro.{{env}}/a/api/v2/micropanel/members' \
            --header 'Content-Type: application/json' \
            --header 'api-key: {{api-key}}' \
            --data '[
                        {
        "emailAddress": "[email protected]",
        "firstName": "ABC",
        "middleName": "E",
        "lastName": "CDF",
        "source": "Panel API",
        "mobileNumber": "+91-9998887765",
        "username": "abctest2",
        "custom1": "",
        "custom2": "",
        "custom3": "",
        "custom4": "",
        "custom5": "",
        "password": "Test@123",
        "profileFields": [
            {////This is for single row text similarly this can be use for large text
                "profileFieldId": 2178,
                "value": "Single Row Value"
            },
            {////Single select option
                "profileFieldId": 577,
                "value": "881"
            },
            {///multiselect option
                "profileFieldId": 578,
                "value": [885,887]
            },
            {////birthdate
                "profileFieldId": 547,
                "value": "1991-01-01"
            },
            {///Germany zipcode, similarly it can be use for other zipcode
                "profileFieldId": 2680,
                "value": "82435"
            },
            {///Numberic value
                "profileFieldId": 576,
                "value": "1234"
            },
            {///Address field
                "profileFieldId": 609,
                "value": {
                    "address1": "Address 1",
                    "address2": "ABC Road",
                    "city": "ABC",
                    "state": "MH",
                    "country": "India"
                }
            }
        ]
    }
                    ]'
        
arrow_rightPython
application/json

             import requests
            import json
            
            url = "https://api.questionpro.{{env}}/a/api/v2/micropanel/members"
            
            payload = json.dumps([
                     {
        "emailAddress": "[email protected]",
        "firstName": "ABC",
        "middleName": "E",
        "lastName": "CDF",
        "source": "Panel API",
        "mobileNumber": "+91-9998887765",
        "username": "abctest2",
        "custom1": "",
        "custom2": "",
        "custom3": "",
        "custom4": "",
        "custom5": "",
        "password": "Test@123",
        "profileFields": [
            {////This is for single row text similarly this can be use for large text
                "profileFieldId": 2178,
                "value": "Single Row Value"
            },
            {////Single select option
                "profileFieldId": 577,
                "value": "881"
            },
            {///multiselect option
                "profileFieldId": 578,
                "value": [885,887]
            },
            {////birthdate
                "profileFieldId": 547,
                "value": "1991-01-01"
            },
            {///Germany zipcode, similarly it can be use for other zipcode
                "profileFieldId": 2680,
                "value": "82435"
            },
            {///Numberic value
                "profileFieldId": 576,
                "value": "1234"
            },
            {///Address field
                "profileFieldId": 609,
                "value": {
                    "address1": "Address 1",
                    "address2": "ABC Road",
                    "city": "ABC",
                    "state": "MH",
                    "country": "India"
                }
            }
        ]
    }
                            ])
            headers = {
              'Content-Type': 'application/json',
              'apiKey': '{{api-key}}'
                        }
            
            response = requests.request("POST", url, headers=headers, data=payload)
            
            print(response.text)  
            
arrow_rightPHP
application/json

    <php
                 $curl = curl_init();
            
            curl_setopt_array($curl, array(
              CURLOPT_URL => 'https://api.questionpro.{{env}}/a/api/v2/micropanel/members',
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => '',
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 0,
              CURLOPT_FOLLOWLOCATION => true,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => 'POST',
              CURLOPT_POSTFIELDS =>'[
                    {
        "emailAddress": "[email protected]",
        "firstName": "ABC",
        "middleName": "E",
        "lastName": "CDF",
        "source": "Panel API",
        "mobileNumber": "+91-9998887765",
        "username": "abctest2",
        "custom1": "",
        "custom2": "",
        "custom3": "",
        "custom4": "",
        "custom5": "",
        "password": "Test@123",
        "profileFields": [
            {////This is for single row text similarly this can be use for large text
                "profileFieldId": 2178,
                "value": "Single Row Value"
            },
            {////Single select option
                "profileFieldId": 577,
                "value": "881"
            },
            {///multiselect option
                "profileFieldId": 578,
                "value": [885,887]
            },
            {////birthdate
                "profileFieldId": 547,
                "value": "1991-01-01"
            },
            {///Germany zipcode, similarly it can be use for other zipcode
                "profileFieldId": 2680,
                "value": "82435"
            },
            {///Numberic value
                "profileFieldId": 576,
                "value": "1234"
            },
            {///Address field
                "profileFieldId": 609,
                "value": {
                    "address1": "Address 1",
                    "address2": "ABC Road",
                    "city": "ABC",
                    "state": "MH",
                    "country": "India"
                }
            }
        ]
    }
                                ]',
              CURLOPT_HTTPHEADER => array(
                'Content-Type: application/json',
                'apiKey: {{api-key}}'
              ),
            ));
            
            $response = curl_exec($curl);
            
            curl_close($curl);
            echo $response;
            

Responses

arrow_rightExample
application/json

        {
                    "response": {
                        "totalMemberScanned": 1,
                        "newMemberAdded": 1,
                        "existingMember": 0,
                        "duplicateEmailAddress": 0,
                        "invalidEmailAddress": 0,
                        "invalidMobileNumber": 1,
                        "duplicateUsername": 0,
                        "invalidUsername": 0,
                        "rejectedCount": 0
                    },
                    "requestID": "77ec3026-cd50-449c-9b26-04a4e783362b"
                }

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