API V2
API V2
https://api.questionpro.{{env}}/a/api/v2/cx/transactions/{{transactionID}}
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
{
"response": {
"feedbackID": 11,
"cXSegmentID": 6,
"cxUserID": 0,
"cxDate": "2022-07-11",
"timestamp": "2022-07-12T06:55:54.000+00:00",
"transactionBatchID": -99,
"responseSetID": 0,
"status": 9,
"productID": 0,
"memberStatus": 0,
"panelMemberID": 123123,
"cxDistributionBatchID": -99,
"surveyID": 6865,
"languageID": -1,
"orgID": 0,
"transactionOwnerEmails": null,
"sendSurveyTs": "2022-07-12T06:55:54.000+00:00",
"emailTemplateID": -1,
"smsTemplateID": -1,
"sendOption": 1,
"appliedRules": "1_0_",
"invitationSentTs": "2022-07-12T06:55:54.000+00:00",
"reminderCount": 0,
"nextReminderTs": null,
"maxReminderCount": 0,
"importType": 1,
"workflowProcessID": 1,
"panelLogID": 1,
"custom1": null,
"custom2": null,
"custom3": null,
"custom4": null,
"custom5": null,
"custom6": null,
"custom7": null,
"custom8": null,
"custom9": null,
"custom10": null,
"custom11": null,
"custom12": null,
"custom13": null,
"custom14": null,
"custom15": null,
"custom16": null,
"custom17": null,
"custom18": null,
"custom19": null,
"custom20": null,
"custom21": null,
"custom22": null,
"custom23": null,
"custom24": null,
"custom25": null,
"custom26": null,
"custom27": null,
"custom28": null,
"custom29": null,
"custom30": null,
"custom31": null,
"custom32": null,
"custom33": null,
"custom34": null,
"custom35": null,
"custom36": null,
"custom37": null,
"custom38": null,
"custom39": null,
"custom40": null,
"custom41": null,
"custom42": null,
"custom43": null,
"custom44": null,
"custom45": null,
"custom46": null,
"custom47": null,
"custom48": null,
"custom49": null,
"custom50": null,
"custom51": "",
"custom52": "",
"custom53": "",
"custom54": "",
"custom55": "",
"custom56": "",
"custom57": "",
"custom58": "",
"custom59": "",
"custom60": "",
"custom61": "",
"custom62": "",
"custom63": "",
"custom64": "",
"custom65": "",
"custom66": "",
"custom67": "",
"custom68": "",
"custom69": "",
"custom70": "",
"custom71": "",
"custom72": "",
"custom73": "",
"custom74": "",
"custom75": "",
"custom76": "",
"custom77": "",
"custom78": "",
"custom79": "",
"custom80": "",
"custom81": "",
"custom82": "",
"custom83": "",
"custom84": "",
"custom85": "",
"custom86": "",
"custom87": "",
"custom88": "",
"custom89": "",
"custom90": "",
"custom91": "",
"custom92": "",
"custom93": "",
"custom94": "",
"custom95": "",
"custom96": "",
"custom97": "",
"custom98": "",
"custom99": "",
"custom100": "",
"id": 6,
},
"requestID": "4012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"productID": {
"type": "integer"
},
"languageID": {
"type": "integer"
},
"custom80": {
"type": "string"
},
"custom82": {
"type": "string"
},
"custom81": {
"type": "string"
},
"custom84": {
"type": "string"
},
"custom83": {
"type": "string"
},
"custom86": {
"type": "string"
},
"custom85": {
"type": "string"
},
"custom88": {
"type": "string"
},
"custom87": {
"type": "string"
},
"custom89": {
"type": "string"
},
"id": {
"type": "integer"
},
"custom71": {
"type": "string"
},
"custom70": {
"type": "string"
},
"custom73": {
"type": "string"
},
"custom72": {
"type": "string"
},
"custom75": {
"type": "string"
},
"custom74": {
"type": "string"
},
"custom77": {
"type": "string"
},
"custom76": {
"type": "string"
},
"custom79": {
"type": "string"
},
"reminderCount": {
"type": "integer"
},
"custom78": {
"type": "string"
},
"status": {
"type": "integer"
},
"custom20": {
"type": "null"
},
"transactionOwnerEmails": {
"type": "null"
},
"custom22": {
"type": "null"
},
"custom21": {
"type": "null"
},
"custom24": {
"type": "null"
},
"custom23": {
"type": "null"
},
"custom26": {
"type": "null"
},
"custom25": {
"type": "null"
},
"custom28": {
"type": "null"
},
"custom27": {
"type": "null"
},
"emailTemplateID": {
"type": "integer"
},
"custom29": {
"type": "null"
},
"timestamp": {
"type": "string"
},
"surveyID": {
"type": "integer"
},
"cxDate": {
"type": "string"
},
"custom91": {
"type": "string"
},
"custom90": {
"type": "string"
},
"custom93": {
"type": "string"
},
"cxUserID": {
"type": "integer"
},
"custom92": {
"type": "string"
},
"custom95": {
"type": "string"
},
"custom94": {
"type": "string"
},
"custom97": {
"type": "string"
},
"custom96": {
"type": "string"
},
"custom11": {
"type": "null"
},
"custom99": {
"type": "string"
},
"custom10": {
"type": "null"
},
"custom98": {
"type": "string"
},
"custom13": {
"type": "null"
},
"custom12": {
"type": "null"
},
"custom15": {
"type": "null"
},
"custom14": {
"type": "null"
},
"custom17": {
"type": "null"
},
"custom16": {
"type": "null"
},
"custom19": {
"type": "null"
},
"custom18": {
"type": "null"
},
"responseSetID": {
"type": "integer"
},
"smsTemplateID": {
"type": "integer"
},
"workflowProcessID": {
"type": "integer"
},
"custom40": {
"type": "null"
},
"custom42": {
"type": "null"
},
"custom41": {
"type": "null"
},
"custom44": {
"type": "null"
},
"custom43": {
"type": "null"
},
"custom46": {
"type": "null"
},
"custom45": {
"type": "null"
},
"custom48": {
"type": "null"
},
"custom47": {
"type": "null"
},
"appliedRules": {
"type": "string"
},
"custom49": {
"type": "null"
},
"cXSegmentID": {
"type": "integer"
},
"feedbackID": {
"type": "integer"
},
"orgID": {
"type": "integer"
},
"custom31": {
"type": "null"
},
"custom30": {
"type": "null"
},
"custom33": {
"type": "null"
},
"custom32": {
"type": "null"
},
"custom35": {
"type": "null"
},
"custom34": {
"type": "null"
},
"custom37": {
"type": "null"
},
"custom36": {
"type": "null"
},
"custom39": {
"type": "null"
},
"custom38": {
"type": "null"
},
"invitationSentTs": {
"type": "string"
},
"panelMemberID": {
"type": "integer"
},
"sendOption": {
"type": "integer"
},
"memberStatus": {
"type": "integer"
},
"custom60": {
"type": "string"
},
"custom62": {
"type": "string"
},
"custom61": {
"type": "string"
},
"custom64": {
"type": "string"
},
"custom63": {
"type": "string"
},
"custom66": {
"type": "string"
},
"custom65": {
"type": "string"
},
"importType": {
"type": "integer"
},
"custom9": {
"type": "null"
},
"custom68": {
"type": "string"
},
"custom67": {
"type": "string"
},
"cxDistributionBatchID": {
"type": "integer"
},
"custom69": {
"type": "string"
},
"custom3": {
"type": "null"
},
"custom4": {
"type": "null"
},
"custom1": {
"type": "null"
},
"maxReminderCount": {
"type": "integer"
},
"custom2": {
"type": "null"
},
"custom7": {
"type": "null"
},
"custom8": {
"type": "null"
},
"custom5": {
"type": "null"
},
"custom6": {
"type": "null"
},
"sendSurveyTs": {
"type": "string"
},
"custom51": {
"type": "string"
},
"custom50": {
"type": "null"
},
"custom100": {
"type": "string"
},
"custom53": {
"type": "string"
},
"panelLogID": {
"type": "integer"
},
"custom52": {
"type": "string"
},
"custom55": {
"type": "string"
},
"transactionBatchID": {
"type": "integer"
},
"custom54": {
"type": "string"
},
"custom57": {
"type": "string"
},
"custom56": {
"type": "string"
},
"custom59": {
"type": "string"
},
"custom58": {
"type": "string"
},
"nextReminderTs": {
"type": "null"
}
},
"additionalProperties": false,
"required": [
"productID",
"languageID",
"custom80",
"smsTemplateID",
"workflowProcessID",
"custom82",
"custom81",
"custom84",
"custom83",
"custom86",
"custom85",
"custom88",
"custom87",
"custom89",
"appliedRules",
"id",
"cXSegmentID",
"feedbackID",
"custom71",
"custom70",
"custom73",
"custom72",
"orgID",
"custom75",
"custom74",
"custom77",
"custom76",
"custom79",
"reminderCount",
"custom78",
"invitationSentTs",
"panelMemberID",
"status",
"sendOption",
"memberStatus",
"custom60",
"custom62",
"custom61",
"custom64",
"custom63",
"custom66",
"custom65",
"importType",
"custom68",
"custom67",
"cxDistributionBatchID",
"custom69",
"emailTemplateID",
"maxReminderCount",
"timestamp",
"surveyID",
"sendSurveyTs",
"cxDate",
"custom91",
"custom90",
"custom93",
"cxUserID",
"custom92",
"custom51",
"custom95",
"custom94",
"custom100",
"custom53",
"custom97",
"panelLogID",
"custom52",
"custom96",
"custom55",
"custom99",
"transactionBatchID",
"custom54",
"custom98",
"custom57",
"custom56",
"custom59",
"custom58",
"responseSetID"
]
},
"requestID": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"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"
]
}