Get /folders/{{folder-id}}/surveys

Example Request

https://api.questionpro.{{env}}/a/api/v2/users/{{user-id}}/folders/{{folder-id}}/surveys?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
user-id integer
required
folder-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/users/{{user-id}}/folders/{{folder-id}}/surveys?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/users/{{user-id}}/folders/{{folder-id}}/surveys?page=1&perPage=100"

payload = {}
headers = {
  'api-key': '{{api-key}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
            
arrow_rightPHP - cURL
Snippet copied successfully.
application/json

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.questionpro.{{env}}/a/api/v2/users/{{user-id}}/folders/{{folder-id}}/surveys?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": [
                                
                                {
                                    "surveyID": 2345678,
                                    "folderID": 9876543,
                                    "name": "Product Research",
                                    "url": "https://www.questionpro.com/t/XXXXXXXXXX",
                                    "status": "Active",
                                    "creationDate": "17 Nov, 2020 12:00:00 AM PST",
                                    "modifiedDate": "17 Nov, 2020 02:51:38 AM PST",
                                    "thankYouMessage": "Thank you for completing this survey.",
                                    "responseQuota": 0,
                                    "expiryDate": "",
                                    "inactiveText": "This Survey has been deactivated by the owner.",
                                    "abbs": false,
                                    "saveAndContinue": false,
                                    "surveyFinishMode": 0,
                                    "completedText": "",
                                    "terminatedText": "Thank You for completing the survey, but at this time your profile does not fit our criteria.",
                                    "quotaOverlimitText": "Thank you for your time but we have already received the required responses.",
                                    "hasScoringLogic": false,
                                    "completedResponses": 5,
                                    "viewedResponses": 41,
                                    "startedResponses": 30,
                                    "terminatedResponses": 3,
                                    "lastResponseReceived": "2021-03-02 02:37:31.0",
                                    "surveyLanguages": [
                                        {
                                            "name": "English",
                                            "contents": null,
                                            "default": true
                                        }
                                    ]
                                },
                                {
                                    "surveyID": 3456789,
                                    "folderID": 9876543,
                                    "name": "Monadic Testing",
                                    "url": "https://www.questionpro.com/t/XXXXXXXXXX",
                                    "status": "Active",
                                    "creationDate": "16 Nov, 2020 12:00:00 AM PST",
                                    "modifiedDate": "16 Nov, 2020 03:12:04 PM PST",
                                    "thankYouMessage": "Thank you for completing this survey.",
                                    "responseQuota": 0,
                                    "expiryDate": "",
                                    "inactiveText": "This Survey has been deactivated by the owner.",
                                    "abbs": false,
                                    "saveAndContinue": false,
                                    "surveyFinishMode": 15,
                                    "completedText": "Thank you for completing this survey.",
                                    "terminatedText": "Your profile does not fit our criteria. Thank you for your time",
                                    "quotaOverlimitText": "Thank you for your time but we have already received the required responses.",
                                    "hasScoringLogic": false,
                                    "logoUrl": "https://www.questionpro.com/qp_userimages/sub-3/1234567/qp.png",
                                    "completedResponses": 14,
                                    "viewedResponses": 31,
                                    "startedResponses": 20,
                                    "terminatedResponses": 2,
                                    "lastResponseReceived": "2021-02-02 02:37:31.0",
                                    "surveyLanguages": [
                                        {
                                            "name": "English",
                                            "contents": null,
                                            "default": true
                                        }
                                    ]
                                }
                            ],
                            "pagination": {
                                "perPage": 100,
                                "totalItems": 2,
                                "currentPage": 1,
                                "totalPages": 1,
                                "links": {
                                    "self": "https://api.questionpro.{{env}}/a/api/v2/users/{{user-id}}/folders/{{folder-id}}/surveys?page=1&perPage=100",
                                    "prev": null,
                                    "next": "",
                                    "first": "https://api.questionpro.{{env}}/a/api/v2/users/{{user-id}}/folders/{{folder-id}}/surveys?page=1&perPage=100",
                                    "last": "https://api.questionpro.{{env}}/a/api/v2/users/{{user-id}}/folders/{{folder-id}}/surveys?page=1&perPage=100"
                                }
                            },
                            "requestID": "7012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
                        }
                    
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": "string"
            },
            "last": {
              "type": "string"
            },
            "prev": {
              "type": "null"
            },
            "self": {
              "type": "string"
            },
            "first": {
              "type": "string"
            }
          },
          "additionalProperties": false,
          "required": [
            "next",
            "last",
            "self",
            "first"
          ]
        },
        "currentPage": {
          "type": "integer"
        }
      },
      "additionalProperties": false,
      "required": [
        "totalItems",
        "perPage",
        "totalPages",
        "links",
        "currentPage"
      ]
    },
    "response": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "viewedResponses": {
            "type": "integer"
          },
          "surveyFinishMode": {
            "type": "integer"
          },
          "inactiveText": {
            "type": "string"
          },
          "startedResponses": {
            "type": "integer"
          },
          "folderID": {
            "type": "integer"
          },
          "expiryDate": {
            "type": "string"
          },
          "terminatedResponses": {
            "type": "integer"
          },
          "responseQuota": {
            "type": "integer"
          },
          "hasScoringLogic": {
            "type": "boolean"
          },
          "saveAndContinue": {
            "type": "boolean"
          },
          "abbs": {
            "type": "boolean"
          },
          "surveyID": {
            "type": "integer"
          },
          "completedText": {
            "type": "string"
          },
          "quotaOverlimitText": {
            "type": "string"
          },
          "thankYouMessage": {
            "type": "string"
          },
          "terminatedText": {
            "type": "string"
          },
          "surveyLanguages": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "default": {
                  "type": "boolean"
                },
                "contents": {
                  "type": "null"
                },
                "name": {
                  "type": "string"
                }
              },
              "additionalProperties": false,
              "required": [
                "default",
                "name"
              ]
            }
          },
          "creationDate": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "logoUrl": {
            "type": "string"
          },
          "completedResponses": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "modifiedDate": {
            "type": "string"
          },
          "lastResponseReceived": {
            "type": "string"
          },
          "status": {
            "type": "string"
          }
        },
        "additionalProperties": false,
        "required": [
          "viewedResponses",
          "surveyFinishMode",
          "inactiveText",
          "startedResponses",
          "folderID",
          "expiryDate",
          "terminatedResponses",
          "responseQuota",
          "hasScoringLogic",
          "saveAndContinue",
          "abbs",
          "surveyID",
          "completedText",
          "quotaOverlimitText",
          "thankYouMessage",
          "terminatedText",
          "surveyLanguages",
          "creationDate",
          "url",
          "completedResponses",
          "name",
          "modifiedDate",
          "lastResponseReceived",
          "status"
        ]
      }
    },
    "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"
  ]
}