Get /micropanel/templates

Example Request

https://api.questionpro.{{env}}/a/api/v2/micropanel/templates?languageID={{languageID}}&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 template info, you need to provide the language ID as a parameter in the api. So, for that, please refer this Link

If the language ID parameter is not passed, the API will return the templates of the language which is set Default for the panel.


Authorization

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

Request Parameters

arrow_rightPath Parameters
languageID 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/templates?languageID={{languageID}}&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/templates?languageID={{languageID}}&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/templates?languageID={{languageID}}&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": [
        {
            "templateId": 62858,
            "name": "Default Email Invitation",
            "emailSubject": " Survey Invitation ",
            "emailBody": "Hello, We would appreciate your feedback in our online survey. All responses will remain confidential and secure. Thank you in advance for your valuable insights. Your input will be used to ensure that we continue to meet your needs. We appreciate your trust and look forward to serving you in the future. We have contracted with QuestionPro, an independent research firm, to field your confidential survey responses. Please click on this link to complete the survey: Please contact [email protected] with any questions. Thank You ",
            "smsText": "Thank you for being part of {COMMUNITY_NAME} Community. Here's an interesting study for you. To give your valuable feedback, follow the link below.{SURVEY_LINK}Thank you.",
            "language": "English"
        },
        {
            "templateId": 124245,
            "name": "[car] Default Email Invitation",
            "emailSubject": "car - Earn Points",
            "emailBody": "Dear Community Member, Thank you for joining the car research community. We have a very interesting study for you, which shouldnt take more than 5 minutes of your time. As always, we value your feedback and assure you that the data collected will only be used for research purposes. In essence, we ask that you provide your candid and honest opinion. This survey is designed to take no more than 5 minutes of your time. At the completion of the survey, your account will be credited. Please click on the link to start the survey: {SURVEY_LINK} We look forward to your participation! The car Team",
            "smsText": "Thank you for being part of {COMMUNITY_NAME} Community. Here's an interesting study for you. To give your valuable feedback, follow the link below.{SURVEY_LINK}Thank you.",
            "language": "English"
        }
    ],
    "pagination": {
        "perPage": 100,
        "totalItems": 2,
        "currentPage": 1,
        "totalPages": 1,
        "links": {
            "self": "https://api.questionpro.{{env}}/a/api/v2/micropanel/templates?languageID={{languageID}}",
            "prev": null,
            "next": null,
            "first": "https://api.questionpro.{{env}}/a/api/v2/micropanel/templates?languageID={{languageID}}&page=1&perPage=100",
            "last": "https://api.questionpro.{{env}}/a/api/v2/micropanel/templates?languageID={{languageID}}&page=1&perPage=100"
        }
    },
    "requestID": "52e6412d-ce63-42bb-94f9-4c8fe22b0d27"
    
    }

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": {
          "emailBody": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "language": {
            "type": "string"
          },
          "templateId": {
            "type": "integer"
          },
          "emailSubject": {
            "type": "string"
          },
          "smsText": {
            "type": "string"
          }
        },
        "additionalProperties": false,
        "required": [
          "emailBody",
          "name",
          "language",
          "templateId",
          "emailSubject",
          "smsText"
        ]
      }
    },
    "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"
  ]
}