Get /micropanel/members/{{member-id}}/responses

Example Request

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

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
member-id integer
required
page integer
optional - defalut 1
perPage integer
optional - defalut 100

Example Code

arrow_rightcURL
Snippet copied successfully.
application/json

            curl --location 'https://api.questionpro.{{env}}/a/api/v2/micropanel/members/{{member-id}}/responses?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/{{member-id}}/responses?page=1&perPage=100"
                payload = {}
                headers = {
      'apiKey': '{{api-key}}'
    }
    
                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/{{member-id}}/responses?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": [
        {
            "emailAddress": "[email protected]",
            "panelMemberID": 16326143,
            "responses": [
                {
                    "panelLogID": 35811362,
                    "surveyID": 11172925,
                    "surveyName": "Signup Survey",
                    "responseID": 111903698
                },
                {
                    "panelLogID": 35811363,
                    "surveyID": 11149347,
                    "surveyName": "About your pet",
                    "responseID": 111904116
                },
                {
                    "panelLogID": 35811364,
                    "surveyID": 11280073,
                    "surveyName": "Exercising with your pet(s)",
                    "responseID": 111904089
                }
            ]
        }
    ],
    "pagination": {
        "perPage": 100,
        "totalItems": 3,
        "currentPage": 1,
        "totalPages": 1,
        "links": {
            "self": "https://api.questionpro.com/a/api/v2/micropanel/members/{{member-id}}/responses?page=1&perPage=100",
            "prev": null,
            "next": null,
            "first": "https://api.questionpro.com/a/api/v2/micropanel/members/{{member-id}}/responses?page=1&perPage=100",
            "last": "https://api.questionpro.com/a/api/v2/micropanel/members/{{member-id}}/responses?page=1&perPage=100"
        }
    },
    "requestID": "ee8efa0b-efa1-42ed-b4ab-9f29137b59f1"
}
            
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": {
          "emailAddress": {
            "type": "string",
            "format": "email"
          },
          "responses": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "surveyID": {
                  "type": "integer"
                },
                "surveyName": {
                  "type": "string"
                },
                "panelLogID": {
                  "type": "integer"
                },
                "responseID": {
                  "type": "integer"
                }
              },
              "additionalProperties": false,
              "required": [
                "surveyID",
                "surveyName",
                "panelLogID",
                "responseID"
              ]
            }
          },
          "panelMemberID": {
            "type": "integer"
          }
        },
        "additionalProperties": false,
        "required": [
          "emailAddress",
          "responses",
          "panelMemberID"
        ]
      }
    },
    "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"
  ]
}