API V2
API V2
https://api.questionpro.{{env}}/a/api/v2/surveys/{{surveyID}}/questions?page=1&perPage=100
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
{
"response": [
{
"questionID": 17617688,
"blockID": 355,
"type": "matrix_checkbox",
"text": "testing without na",
"code": "Q5",
"orderNumber": 1,
"required": false,
"rows": [
{
"rowID": 17617688,
"text": "Row 1",
"columns": [
{
"columnID": 220966,
"text": "Column 1",
"isDefault": false,
"hasNA": false
},
{
"columnID": 220967,
"text": "Column 2",
"isDefault": false,
"hasNA": false
}
]
},
{
"rowID": 17617689,
"text": "Row 2",
"columns": [
{
"columnID": 220968,
"text": "Column 1",
"isDefault": false,
"hasNA": false
},
{
"columnID": 220969,
"text": "Column 2",
"isDefault": false,
"hasNA": false
}
]
}
],
"columns": [
{
"columnID": 220966,
"text": "Column 1",
"isDefault": false,
"hasNA": false
},
{
"columnID": 220967,
"text": "Column 2",
"isDefault": false,
"hasNA": false
}
],
"randomizedRows": false,
"notApplicableAnswer": false,
"matrixType": "Likert",
"mobileRendering": true
},
{
"questionID": 17617684,
"blockID": 355,
"type": "matrix_checkbox",
"text": "",
"code": "Q4",
"orderNumber": 2,
"required": false,
"rows": [
{
"rowID": 17617684,
"text": "Row 1",
"columns": [
{
"columnID": 220956,
"text": " col 1",
"isDefault": false,
"hasNA": false
},
{
"columnID": 220960,
"text": "N/A col",
"isDefault": false,
"hasNA": true
}
]
},
{
"rowID": 17617685,
"text": "Row 2",
"columns": [
{
"columnID": 220958,
"text": " col 1",
"isDefault": false,
"hasNA": false
},
{
"columnID": 220961,
"text": "N/A col",
"isDefault": false,
"hasNA": true
}
]
}
],
"columns": [
{
"columnID": 220956,
"text": " col 1",
"isDefault": false,
"hasNA": false
}
],
"randomizedRows": false,
"notApplicableAnswer": true,
"matrixType": "Likert",
"mobileRendering": true
},
{
"questionID": 17617669,
"blockID": 355,
"type": "matrix_radio",
"text": "testing matrix question",
"code": "Q3",
"orderNumber": 3,
"required": false,
"rows": [
{
"rowID": 17617669,
"text": "Row 1",
"columns": [
{
"columnID": 220910,
"text": "Column 1",
"isDefault": false,
"hasNA": false
},
{
"columnID": 220911,
"text": "Column 2",
"isDefault": false,
"hasNA": false
},
{
"columnID": 220914,
"text": "N/A",
"isDefault": false,
"hasNA": true
}
]
},
{
"rowID": 17617670,
"text": "Row 2",
"columns": [
{
"columnID": 220912,
"text": "Column 1",
"isDefault": false,
"hasNA": false
},
{
"columnID": 220913,
"text": "Column 2",
"isDefault": false,
"hasNA": false
},
{
"columnID": 220915,
"text": "N/A",
"isDefault": false,
"hasNA": true
}
]
}
],
"columns": [
{
"columnID": 220910,
"text": "Column 1",
"isDefault": false,
"hasNA": false
},
{
"columnID": 220911,
"text": "Column 2",
"isDefault": false,
"hasNA": false
}
],
"anchor": {
"leftAnchor": "",
"rightAnchor": ""
},
"randomizedRows": false,
"notApplicableAnswer": true,
"matrixType": "Likert",
"mobileRendering": true
}
],
"pagination": {
"perPage": 100,
"totalItems": 3,
"currentPage": 1,
"totalPages": 1,
"links": {
"self": "https://api.questionpro.{{env}}/a/api/v2/surveys/{{surveyID}}/questions",
"prev": null,
"next": null,
"first": "https://api.questionpro.{{env}}/a/api/v2/surveys/{{surveyID}}/questions?page=1&perPage=100",
"last": "https://.questionpro.{{env}}/a/api/v2/surveys/{{surveyID}}/questions?page=1&perPage=100"
}
},
"requestID": "4012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
}
{
"$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": {
"mobileRendering": {
"type": "boolean"
},
"questionID": {
"type": "integer"
},
"code": {
"type": "string"
},
"orderNumber": {
"type": "integer"
},
"columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"isDefault": {
"type": "boolean"
},
"columnID": {
"type": "integer"
},
"hasNA": {
"type": "boolean"
},
"text": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"isDefault",
"columnID",
"hasNA",
"text"
]
}
},
"randomizedRows": {
"type": "boolean"
},
"matrixType": {
"type": "string"
},
"type": {
"type": "string"
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"isDefault": {
"type": "boolean"
},
"columnID": {
"type": "integer"
},
"hasNA": {
"type": "boolean"
},
"text": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"isDefault",
"columnID",
"hasNA",
"text"
]
}
},
"text": {
"type": "string"
},
"rowID": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"columns",
"text",
"rowID"
]
}
},
"required": {
"type": "boolean"
},
"notApplicableAnswer": {
"type": "boolean"
},
"blockID": {
"type": "integer"
},
"anchor": {
"type": "object",
"properties": {
"leftAnchor": {
"type": "string"
},
"rightAnchor": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"leftAnchor",
"rightAnchor"
]
},
"text": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"mobileRendering",
"questionID",
"code",
"orderNumber",
"columns",
"randomizedRows",
"matrixType",
"type",
"rows",
"required",
"notApplicableAnswer",
"blockID",
"text"
]
}
},
"requestID": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"pagination",
"response",
"requestID"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "BAD_REQUEST",
"httpStatusCode": 400,
"id" : "1000",
"message": "Invalid URL parameters",
"resourceUrl":"resource_url"
}
}
}
{
"$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"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "UNAUTHORIZED",
"httpStatusCode": 401,
"id" : "1010",
"message": "Incorrect API Key",
"resourceUrl":"resource_url"
}
}
}
{
"$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"
]
}
{
"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"
}
}
}
{
"$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"
]
}
{
"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"
}
}
}
{
"$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"
]
}
{
"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"
}
}
}
{
"$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"
]
}