(Cloud) get form templates

Background

This API returns data about all 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
UpRaise for Employee Success	https://employee-success.upraise.io/rest/upraise/public/1.0/form/getTemplates
UpRaise People	https://people.upraise.io/rest/upraise/public/1.0/form/getTemplates

Request parameters

Provide the startAt & maxResults here.

Sample JSON response

{
    "startAt": 0,
    "maxResults": 10,
    "total": 1054,
    "results": [
        {
            "id": 5718,
            "name": "16-04-2025",
            "description": "Describe this form",
            "descriptionHtml": "<div>Describe this form</div>",
            "status": {
                "id": 0,
                "name": "Draft"
            },
            "baseTemplate": "Survey",
            "modifiedBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "workflow": "Assign to UpRaise Admin",
            "noOfDistributions": 0,
            "getQuestionsUrl": "<baseURL>/rest/upraise/public/1.0/form/getTemplateQuestions/5718",
            "createdBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "created": "16/04/2025 7:23:21 AM",
            "modified": "16/04/2025 7:23:21 AM",
            "isDefault": false
        },
        {
            "id": 5716,
            "name": "Score disabled ",
            "description": "Describe this form",
            "descriptionHtml": "<div>Describe this form</div>",
            "status": {
                "id": 0,
                "name": "Draft"
            },
            "baseTemplate": "360 Degree Review",
            "modifiedBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "workflow": "Assign to UpRaise Admin - 360 Review",
            "noOfDistributions": 0,
            "getQuestionsUrl": "<baseURL>/rest/upraise/public/1.0/form/getTemplateQuestions/5716",
            "createdBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "created": "16/04/2025 5:26:34 AM",
            "modified": "16/04/2025 5:26:34 AM",
            "isDefault": false
        },
        {
            "id": 5715,
            "name": "alloted ",
            "description": "Describe this form",
            "descriptionHtml": "<div>Describe this form</div>",
            "status": {
                "id": 0,
                "name": "Draft"
            },
            "baseTemplate": "Self & Manager Review",
            "modifiedBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "workflow": "Team member assessment followed by Reviewer",
            "noOfDistributions": 0,
            "getQuestionsUrl": "<baseURL>/rest/upraise/public/1.0/form/getTemplateQuestions/5715",
            "createdBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "created": "15/04/2025 11:09:47 AM",
            "modified": "15/04/2025 11:09:47 AM",
            "isDefault": false
        },
        {
            "id": 5705,
            "name": "done ",
            "description": "Describe this form",
            "descriptionHtml": "<div>Describe this form</div>",
            "status": {
                "id": 0,
                "name": "Draft"
            },
            "baseTemplate": "360 Degree Review",
            "modifiedBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "workflow": "Assign to UpRaise Admin - 360 Review",
            "noOfDistributions": 0,
            "getQuestionsUrl": "<baseURL>/rest/upraise/public/1.0/form/getTemplateQuestions/5705",
            "createdBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "created": "03/04/2025 7:33:55 AM",
            "modified": "03/04/2025 7:33:55 AM",
            "isDefault": false
        },
        {
            "id": 5704,
            "name": "03-04-2025-02",
            "description": "Describe this form",
            "descriptionHtml": "<div>Describe this form</div>",
            "status": {
                "id": 0,
                "name": "Draft"
            },
            "baseTemplate": "360 Degree Review",
            "modifiedBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "workflow": "Assign to UpRaise Admin - 360 Review",
            "noOfDistributions": 0,
            "getQuestionsUrl": "<baseURL>/rest/upraise/public/1.0/form/getTemplateQuestions/5704",
            "createdBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "created": "03/04/2025 7:29:27 AM",
            "modified": "03/04/2025 7:29:27 AM",
            "isDefault": false
        },
        {
            "id": 5703,
            "name": "03-04-2025-01",
            "description": "Describe this form",
            "descriptionHtml": "<div>Describe this form</div>",
            "status": {
                "id": 0,
                "name": "Draft"
            },
            "baseTemplate": "Survey",
            "modifiedBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "workflow": "Assign to Reviewer's Manager",
            "noOfDistributions": 1,
            "getQuestionsUrl": "<baseURL>/rest/upraise/public/1.0/form/getTemplateQuestions/5703",
            "createdBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "created": "03/04/2025 7:19:09 AM",
            "modified": "03/04/2025 7:19:09 AM",
            "isDefault": false
        },
        {
            "id": 5702,
            "name": "03-04-2025",
            "description": "Describe this form",
            "descriptionHtml": "<div>Describe this form</div>",
            "status": {
                "id": 0,
                "name": "Draft"
            },
            "baseTemplate": "Confidential Review",
            "modifiedBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "workflow": "Assign to UpRaise Admin",
            "noOfDistributions": 1,
            "getQuestionsUrl": "<baseURL>/rest/upraise/public/1.0/form/getTemplateQuestions/5702",
            "createdBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "created": "03/04/2025 4:28:19 AM",
            "modified": "03/04/2025 4:28:19 AM",
            "isDefault": false
        },
        {
            "id": 5701,
            "name": "02-04-2025",
            "description": "Describe this form",
            "descriptionHtml": "<div>Describe this form</div>",
            "status": {
                "id": 0,
                "name": "Draft"
            },
            "baseTemplate": "Self & Manager Review",
            "modifiedBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "workflow": "Team member and Reviewer in parallel",
            "noOfDistributions": 1,
            "getQuestionsUrl": "<baseURL>/rest/upraise/public/1.0/form/getTemplateQuestions/5701",
            "createdBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "created": "02/04/2025 10:32:35 AM",
            "modified": "02/04/2025 10:32:35 AM",
            "isDefault": false
        },
        {
            "id": 5698,
            "name": "01-04-2025",
            "description": "Describe this form",
            "descriptionHtml": "<div>Describe this form</div>",
            "status": {
                "id": 0,
                "name": "Draft"
            },
            "baseTemplate": "Self & Manager Review",
            "modifiedBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "workflow": "Team member assessment followed by Reviewer",
            "noOfDistributions": 1,
            "getQuestionsUrl": "<baseURL>/rest/upraise/public/1.0/form/getTemplateQuestions/5698",
            "createdBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "created": "01/04/2025 1:02:36 PM",
            "modified": "01/04/2025 1:02:36 PM",
            "isDefault": false
        },
        {
            "id": 5673,
            "name": "20/03-02",
            "description": "Describe this form",
            "descriptionHtml": "<div>Describe this form</div>",
            "status": {
                "id": 0,
                "name": "Draft"
            },
            "baseTemplate": "Self & Manager Review",
            "modifiedBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "workflow": "Team member and Reviewer in parallel",
            "noOfDistributions": 1,
            "getQuestionsUrl": "<baseURL>/rest/upraise/public/1.0/form/getTemplateQuestions/5673",
            "createdBy": {
                "id": 67253,
                "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            },
            "created": "20/03/2025 11:11:48 AM",
            "modified": "20/03/2025 11:11:48 AM",
            "isDefault": false
        }
    ]
}

API Response Parameters Table

Parent	Parameter	Type	Description	Possible Values
root	startAt	Integer	Pagination start position	`0`
root	maxResults	Integer	Maximum results per page	`10`
root	total	Integer	Total number of results	`1054`
results	id	Integer	Unique ID of the template	`5718, 5716, 5715, ...`
results	name	String	Name of the template	`"16-04-2025", "Score disabled", "alloted", ...`
results	description	String	Description of the template	`"Any form description"`
results	descriptionHtml	String	HTML version of the description	`"<div>Any form description</div>"`
results	status.id	Integer	Status ID	`0`
results	status.name	String	Status label	`"Draft"`
results	baseTemplate	String	Base template used	`"Survey", "360 Degree Review", "Self & Manager Review", ...Any given form template type`
results	modifiedBy.id	Integer	ID of the user who last modified the form	`67253`
results	modifiedBy.jiraUserRestApiUrl	String	API URL to fetch modifier details	Corresponding URLs for each user
results	workflow	String	Workflow process	`"Assign to UpRaise Admin", "Team member assessment followed by Reviewer", ...Any given template workflow in UpRaise`
results	noOfDistributions	Integer	Number of times the template was distributed	`0, 1, ...`
results	getQuestionsUrl	String	API URL to fetch questions in the template	Corresponding URLs
results	createdBy.id	Integer	ID of the user who created the form	`67253`
results	createdBy.jiraUserRestApiUrl	String	API URL to fetch creator details	Corresponding URLs for each user
results	created	String	Date when the template was created	`"16/04/2025 7:23:21 AM", "03/04/2025 7:19:09 AM", ...`
results	modified	String	Date when the template was last modified	`"16/04/2025 7:23:21 AM", "03/04/2025 7:19:09 AM", ...`
results	isDefault	Boolean	Indicates whether this template is the default	`false/true`