/
(Cloud) get form template questions
(Cloud) get form template questions
Background
This API returns all questions from the form templates in UpRaise.
API Details
This API will require valid authentication & will expect the user API token in the request.
Read Create User API token for more details
Below are the endpoints for this API based on which UpRaise app you are using
App name | Endpoint |
|---|
App name | Endpoint |
|---|---|
UpRaise for Employee Success | https://employee-success.upraise.io/rest/upraise/public/1.0/form/getTemplateQuestions/{id} |
UpRaise People | https://people.upraise.io/rest/upraise/public/1.0/form/getTemplateQuestions/{id} |
Request parameters
Provide the form template id here.
Sample JSON response
{
"id": 5715,
"name": "Sales review H1",
"description": "Describe this form",
"descriptionHtml": "<div>Describe this form</div>",
"baseTemplate": "Self & Manager Review",
"workflow": "Team member assessment followed by Reviewer",
"settings": {
"showFeedbackTab": false,
"showIssueTab": false
},
"tabs": [
{
"tabName": "Team Member & Reviewer",
"fields": [
{
"questionName": "Objectives",
"settings": {
"questionType": "SectionStart",
"questionId": 24367,
"details": "",
"score": "Yes",
"weightage": 5,
"sequenceId": 1
}
},
{
"questionName": "Import Objectives",
"settings": {
"questionType": "ImportObjectives",
"questionId": 24368,
"range": "0, 5",
"startAtOne": "No",
"extremeLabels": "Not likely, Extremely likely",
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"sequenceId": 2
}
},
{
"questionName": "Questions",
"settings": {
"questionType": "SectionStart",
"questionId": 24369,
"details": "",
"score": "Yes",
"weightage": 5,
"sequenceId": 3
}
},
{
"questionName": "Single Line Text 1",
"settings": {
"questionType": "SingleLineText",
"questionId": 24370,
"defaultValue": "",
"instructions": "",
"isMandatory": "Yes",
"sequenceId": 4
}
},
{
"questionName": "Section start 3",
"settings": {
"questionType": "SectionStart",
"questionId": 24371,
"details": "",
"score": "Yes",
"weightage": 5,
"sequenceId": 5
}
},
{
"questionName": "Single Line Text 2",
"settings": {
"questionType": "SingleLineText",
"questionId": 24372,
"defaultValue": "",
"instructions": "",
"isMandatory": "Yes",
"sequenceId": 6
}
},
{
"questionName": "Multiple Choice 1",
"settings": {
"questionType": "MultipleChoice",
"questionId": 24373,
"choices": [
{
"id": 1,
"name": "Choice 1",
"score": 1
},
{
"id": 2,
"name": "Choice 2",
"score": 2
},
{
"id": 3,
"name": "Choice 3",
"score": 3
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 7
}
},
{
"questionName": "Date 1",
"settings": {
"questionType": "Date",
"questionId": 24374,
"defaultValue": "",
"instructions": "",
"dateFormat": "DD/MM/YYYYyy",
"isMandatory": "Yes",
"sequenceId": 8
}
},
{
"questionName": "Paragraph Text 1",
"settings": {
"questionType": "ParagraphText",
"questionId": 24375,
"defaultValue": "",
"instructions": "",
"isMandatory": "Yes",
"sequenceId": 9
}
},
{
"questionName": "Check Box 1",
"settings": {
"questionType": "CheckBox",
"questionId": 24376,
"choices": [
{
"id": 0,
"name": "Choice 1"
},
{
"id": 1,
"name": "Choice 2"
},
{
"id": 2,
"name": "Choice 3"
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"sequenceId": 10
}
},
{
"questionName": "Star Ratings 1",
"settings": {
"questionType": "StarRatings",
"questionId": 24377,
"choices": [
{
"id": 1,
"name": "Consistently below expectations",
"score": 1
},
{
"id": 2,
"name": "Below expectations",
"score": 2
},
{
"id": 3,
"name": "Meets expectations",
"score": 3
},
{
"id": 4,
"name": "Exceeds expectations",
"score": 4
},
{
"id": 5,
"name": "Consistently exceeds expectations",
"score": 5
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 11
}
},
{
"questionName": "Dropdown 1",
"settings": {
"questionType": "DropDown",
"questionId": 24378,
"choices": [
{
"id": 1,
"name": "Menu 1",
"score": 1
},
{
"id": 2,
"name": "Menu 2",
"score": 2
},
{
"id": 3,
"name": "Menu 3",
"score": 3
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 12
}
},
{
"questionName": "Yes / No 1",
"settings": {
"questionType": "YesNo",
"questionId": 24379,
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"sequenceId": 13
}
},
{
"questionName": "Opinion Scale 1",
"settings": {
"questionType": "OpinionScale",
"questionId": 24380,
"range": "0, 5",
"startAtOne": "No",
"extremeLabels": "Not likely, Extremely likely",
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 14
}
}
]
},
{
"tabName": "Team Member",
"fields": [
{
"questionName": "Section start 1",
"settings": {
"questionType": "SectionStart",
"questionId": 24381,
"details": "",
"score": "Yes",
"weightage": 5,
"sequenceId": 1
}
},
{
"questionName": "Single Line Text 1",
"settings": {
"questionType": "SingleLineText",
"questionId": 24382,
"defaultValue": "",
"instructions": "",
"isMandatory": "Yes",
"sequenceId": 2
}
},
{
"questionName": "Multiple Choice 1",
"settings": {
"questionType": "MultipleChoice",
"questionId": 24383,
"choices": [
{
"id": 1,
"name": "Choice 1",
"score": 1
},
{
"id": 2,
"name": "Choice 2",
"score": 2
},
{
"id": 3,
"name": "Choice 3",
"score": 3
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 3
}
},
{
"questionName": "Date 1",
"settings": {
"questionType": "Date",
"questionId": 24384,
"defaultValue": "",
"instructions": "",
"dateFormat": "DD/MM/YYYYyy",
"isMandatory": "Yes",
"sequenceId": 4
}
},
{
"questionName": "Opinion Scale 1",
"settings": {
"questionType": "OpinionScale",
"questionId": 24385,
"range": "0, 5",
"startAtOne": "No",
"extremeLabels": "Not likely, Extremely likely",
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 5
}
},
{
"questionName": "Star Ratings 1",
"settings": {
"questionType": "StarRatings",
"questionId": 24386,
"choices": [
{
"id": 1,
"name": "Consistently below expectations",
"score": 1
},
{
"id": 2,
"name": "Below expectations",
"score": 2
},
{
"id": 3,
"name": "Meets expectations",
"score": 3
},
{
"id": 4,
"name": "Exceeds expectations",
"score": 4
},
{
"id": 5,
"name": "Consistently exceeds expectations",
"score": 5
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 6
}
}
]
},
{
"tabName": "Reviewer",
"fields": [
{
"questionName": "Single Line Text 1",
"settings": {
"questionType": "SingleLineText",
"questionId": 24387,
"defaultValue": "",
"instructions": "",
"isMandatory": "Yes",
"sequenceId": 1
}
},
{
"questionName": "Paragraph Text 1",
"settings": {
"questionType": "ParagraphText",
"questionId": 24388,
"defaultValue": "",
"instructions": "",
"isMandatory": "Yes",
"sequenceId": 2
}
},
{
"questionName": "Date 1",
"settings": {
"questionType": "Date",
"questionId": 24389,
"defaultValue": "",
"instructions": "",
"dateFormat": "DD/MM/YYYYyy",
"isMandatory": "Yes",
"sequenceId": 3
}
},
{
"questionName": "Multiple Choice 1",
"settings": {
"questionType": "MultipleChoice",
"questionId": 24390,
"choices": [
{
"id": 1,
"name": "Choice 1",
"score": 1
},
{
"id": 2,
"name": "Choice 2",
"score": 2
},
{
"id": 3,
"name": "Choice 3",
"score": 3
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 4
}
},
{
"questionName": "Check Box 1",
"settings": {
"questionType": "CheckBox",
"questionId": 24391,
"choices": [
{
"id": 0,
"name": "Choice 1"
},
{
"id": 1,
"name": "Choice 2"
},
{
"id": 2,
"name": "Choice 3"
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"sequenceId": 5
}
},
{
"questionName": "Star Ratings 1",
"settings": {
"questionType": "StarRatings",
"questionId": 24392,
"choices": [
{
"id": 1,
"name": "Consistently below expectations",
"score": 1
},
{
"id": 2,
"name": "Below expectations",
"score": 2
},
{
"id": 3,
"name": "Meets expectations",
"score": 3
},
{
"id": 4,
"name": "Exceeds expectations",
"score": 4
},
{
"id": 5,
"name": "Consistently exceeds expectations",
"score": 5
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 6
}
},
{
"questionName": "Dropdown 1",
"settings": {
"questionType": "DropDown",
"questionId": 24393,
"choices": [
{
"id": 1,
"name": "Menu 1",
"score": 1
},
{
"id": 2,
"name": "Menu 2",
"score": 2
},
{
"id": 3,
"name": "Menu 3",
"score": 3
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 7
}
},
{
"questionName": "Yes / No 1",
"settings": {
"questionType": "YesNo",
"questionId": 24394,
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"sequenceId": 8
}
},
{
"questionName": "Opinion Scale 1",
"settings": {
"questionType": "OpinionScale",
"questionId": 24395,
"range": "0, 5",
"startAtOne": "No",
"extremeLabels": "Not likely, Extremely likely",
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 9
}
}
]
},
{
"tabName": "Reviewer Remarks",
"fields": [
{
"questionName": "Section start 1",
"settings": {
"questionType": "SectionStart",
"questionId": 24396,
"details": "",
"score": "Yes",
"weightage": 5,
"sequenceId": 1
}
},
{
"questionName": "Single Line Text 1",
"settings": {
"questionType": "SingleLineText",
"questionId": 24397,
"defaultValue": "",
"instructions": "",
"isMandatory": "Yes",
"sequenceId": 2
}
},
{
"questionName": "Paragraph Text 1",
"settings": {
"questionType": "ParagraphText",
"questionId": 24398,
"defaultValue": "",
"instructions": "",
"isMandatory": "Yes",
"sequenceId": 3
}
},
{
"questionName": "Date 1",
"settings": {
"questionType": "Date",
"questionId": 24399,
"defaultValue": "",
"instructions": "",
"dateFormat": "DD/MM/YYYYyy",
"isMandatory": "Yes",
"sequenceId": 4
}
},
{
"questionName": "Multiple Choice 1",
"settings": {
"questionType": "MultipleChoice",
"questionId": 24400,
"choices": [
{
"id": 1,
"name": "Choice 1",
"score": 1
},
{
"id": 2,
"name": "Choice 2",
"score": 2
},
{
"id": 3,
"name": "Choice 3",
"score": 3
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 5
}
},
{
"questionName": "Check Box 1",
"settings": {
"questionType": "CheckBox",
"questionId": 24401,
"choices": [
{
"id": 0,
"name": "Choice 1"
},
{
"id": 1,
"name": "Choice 2"
},
{
"id": 2,
"name": "Choice 3"
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"sequenceId": 6
}
},
{
"questionName": "Star Ratings 1",
"settings": {
"questionType": "StarRatings",
"questionId": 24402,
"choices": [
{
"id": 1,
"name": "Consistently below expectations",
"score": 1
},
{
"id": 2,
"name": "Below expectations",
"score": 2
},
{
"id": 3,
"name": "Meets expectations",
"score": 3
},
{
"id": 4,
"name": "Exceeds expectations",
"score": 4
},
{
"id": 5,
"name": "Consistently exceeds expectations",
"score": 5
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 7
}
},
{
"questionName": "Dropdown 1",
"settings": {
"questionType": "DropDown",
"questionId": 24403,
"choices": [
{
"id": 1,
"name": "Menu 1",
"score": 1
},
{
"id": 2,
"name": "Menu 2",
"score": 2
},
{
"id": 3,
"name": "Menu 3",
"score": 3
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 8
}
},
{
"questionName": "Yes / No 1",
"settings": {
"questionType": "YesNo",
"questionId": 24404,
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"sequenceId": 9
}
},
{
"questionName": "Opinion Scale 1",
"settings": {
"questionType": "OpinionScale",
"questionId": 24405,
"range": "0, 5",
"startAtOne": "No",
"extremeLabels": "Not likely, Extremely likely",
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 10
}
}
]
},
{
"tabName": "HR Remarks",
"fields": [
{
"questionName": "Single Line Text 1",
"settings": {
"questionType": "SingleLineText",
"questionId": 24406,
"defaultValue": "",
"instructions": "",
"isMandatory": "Yes",
"sequenceId": 1
}
},
{
"questionName": "Paragraph Text 1",
"settings": {
"questionType": "ParagraphText",
"questionId": 24407,
"defaultValue": "",
"instructions": "",
"isMandatory": "Yes",
"sequenceId": 2
}
},
{
"questionName": "Date 1",
"settings": {
"questionType": "Date",
"questionId": 24408,
"defaultValue": "",
"instructions": "",
"dateFormat": "DD/MM/YYYYyy",
"isMandatory": "Yes",
"sequenceId": 3
}
},
{
"questionName": "Multiple Choice 1",
"settings": {
"questionType": "MultipleChoice",
"questionId": 24409,
"choices": [
{
"id": 1,
"name": "Choice 1",
"score": 1
},
{
"id": 2,
"name": "Choice 2",
"score": 2
},
{
"id": 3,
"name": "Choice 3",
"score": 3
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 4
}
},
{
"questionName": "Check Box 1",
"settings": {
"questionType": "CheckBox",
"questionId": 24410,
"choices": [
{
"id": 0,
"name": "Choice 1"
},
{
"id": 1,
"name": "Choice 2"
},
{
"id": 2,
"name": "Choice 3"
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"sequenceId": 5
}
},
{
"questionName": "Star Ratings 1",
"settings": {
"questionType": "StarRatings",
"questionId": 24411,
"choices": [
{
"id": 1,
"name": "Consistently below expectations",
"score": 1
},
{
"id": 2,
"name": "Below expectations",
"score": 2
},
{
"id": 3,
"name": "Meets expectations",
"score": 3
},
{
"id": 4,
"name": "Exceeds expectations",
"score": 4
},
{
"id": 5,
"name": "Consistently exceeds expectations",
"score": 5
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 6
}
},
{
"questionName": "Dropdown 1",
"settings": {
"questionType": "DropDown",
"questionId": 24412,
"choices": [
{
"id": 1,
"name": "Menu 1",
"score": 1
},
{
"id": 2,
"name": "Menu 2",
"score": 2
},
{
"id": 3,
"name": "Menu 3",
"score": 3
}
],
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 7
}
},
{
"questionName": "Yes / No 1",
"settings": {
"questionType": "YesNo",
"questionId": 24413,
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"sequenceId": 8
}
},
{
"questionName": "Opinion Scale 1",
"settings": {
"questionType": "OpinionScale",
"questionId": 24414,
"range": "0, 5",
"startAtOne": "No",
"extremeLabels": "Not likely, Extremely likely",
"instructions": "",
"isMandatory": "Yes",
"addCommentBox": "Yes",
"score": "Yes",
"weightage": 5,
"sequenceId": 9
}
}
]
}
]
}
API Response Parameters Table
Parent | Parameter | Type | Description | Possible Values |
|---|
Parent | Parameter | Type | Description | Possible Values |
|---|---|---|---|---|
root | id | Integer | Unique ID of the template |
|
root | name | String | Name of the template |
|
root | description | String | Description of the template |
|
root | descriptionHtml | String | HTML version of the description |
|
root | baseTemplate | String | Base template used |
|
root | workflow | String | Workflow process |
|
settings | showFeedbackTab | Boolean | Whether the feedback tab is shown |
|
settings | showIssueTab | Boolean | Whether the issue tab is shown |
|
tabs | tabName | String | Name of the tab |
|
fields | questionName | String | Name of the question |
|
fields.settings | questionType | String | Type of question |
|
fields.settings | questionId | Integer | ID of the question |
|
fields.settings | details | String | Additional details if applicable |
|
fields.settings | defaultValue | String | Default value for the question |
|
fields.settings | instructions | String | Instructions for the question |
|
fields.settings | score | String | Whether scoring is enabled |
|
fields.settings | weightage | Integer | Weightage assigned to the question |
|
fields.settings | sequenceId | Integer | Order in which questions appear |
|
fields.settings | isMandatory | String | Indicates if the question is mandatory |
|
fields.settings | addCommentBox | String | Whether comments can be added |
|
fields.settings | dateFormat | String | Date format used (for Date-type questions) |
|
choices | id | Integer | Choice ID (for MultipleChoice, DropDown, etc.) |
|
choices | name | String | Name of the choice |
|
choices | score | Integer | Score associated with the choice |
|
, multiple selections available,