Get distribution users (Cloud app)
Background
This API returns users response in the form distributions 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/getDistributionUserResponses/{id} |
UpRaise People | https://people.upraise.io/rest/upraise/public/1.0/form/getDistributionUserResponses/{id} |
Request parameters
Provide the distribution user id here.
Sample JSON response
Here’s how the response JSON would look like with sample data -
{
"distributionId": 8,
"distributionName": "Software Development Appraisal Form - H2 - 2024",
"distributionDescription": "Software Development - Appraisal Form",
"distributionUserDetails": {
"id": 9,
"isOpen": true,
"teamMember": {
"id": 57,
"jiraUserRestApiUrl": "<base_url>/rest/api/2/user?accountId=<teamMemberAccountId>"
},
"reviewer": {
"id": 58,
"jiraUserRestApiUrl": "<base_url>/rest/api/2/user?accountId=<reviewerAccountId>"
},
"hrUser": {
"id": 57,
"jiraUserRestApiUrl": "<base_url>/rest/api/2/user?accountId=<hrUserAccountId>"
},
"assignedTo": {
"id": 57,
"jiraUserRestApiUrl": "<base_url>/rest/api/2/user?accountId=<assignedToAccountId>"
},
"status": {
"id": 3,
"name": "Complete"
},
"scores": [
{
"name": "Team Member - Mohan Kanawade",
"value": "1.25 / 4.50"
},
{
"name": "Reviewer - mohankanawade",
"value": "2.00 / 5.00"
},
{
"name": "HR Remarks - Mohan Kanawade",
"value": "0.00 / 0.00"
}
]
},
"tabs": [
{
"tabName": "Team Member",
"fields": [
{
"id": 125,
"questionName": "Objectives",
"score": "NA"
},
{
"id": 126,
"questionName": "Import Objectives",
"objectives": [
{
"objectiveId": 7,
"getObjectiveDetailsUrl": "<base_url>/rest/upraise/public/1.0/okr/objective/7",
"response": {
"value": [
{
"id": 3,
"value": "3"
}
],
"commentBox": "To improve productivity, I focus on prioritizing tasks using the Eisenhower Matrix and breaking down complex work into manageable sprints. I follow time-blocking techniques to allocate focused hours for coding, minimizing distractions.\nI also leverage automation tools (CI/CD pipelines, script automation) to reduce repetitive tasks. Code reviews and peer programming help in knowledge sharing and improving code quality. Additionally, I use agile methodologies to plan, execute, and review work efficiently.\nContinuous learning through tech blogs, coding challenges, and workshops helps me stay updated with the latest technologies, further boosting my efficiency.",
"commentBoxInHtml": "<div>To improve productivity, I focus on prioritizing tasks using the Eisenhower Matrix and breaking down complex work into manageable sprints. I follow time-blocking techniques to allocate focused hours for coding, minimizing distractions.\nI also leverage automation tools (CI/CD pipelines, script automation) to reduce repetitive tasks. Code reviews and peer programming help in knowledge sharing and improving code quality. Additionally, I use agile methodologies to plan, execute, and review work efficiently.\nContinuous learning through tech blogs, coding challenges, and workshops helps me stay updated with the latest technologies, further boosting my efficiency.</div>",
"score": "3"
}
},
{
"objectiveId": 12,
"getObjectiveDetailsUrl": "<base_url>/rest/upraise/public/1.0/okr/objective/12",
"response": {
"value": [
{
"id": 4,
"value": "4"
}
],
"commentBox": "When facing a production issue, I follow a structured incident response process:\n1. Identify & Reproduce – I gather logs, error messages, and user reports to understand the issue. I try to reproduce it in a staging environment before making any changes.\n2. Analyze Root Cause – I use log monitoring tools (ELK, Splunk, Datadog) and debugging techniques to pinpoint the issue. If necessary, I perform database queries and check server metrics.\n3. Apply Fix & Test – I create a hotfix branch, implement a solution, and test it thoroughly in a non-production environment.\n4. Deploy & Monitor – After approval, I deploy the fix using zero-downtime deployment and closely monitor the application to ensure stability.\n5. Prevent Future Issues – I conduct a post-mortem analysis, document the resolution, and implement preventive measures like automated alerts, better exception handling, and code optimizations.\n",
"commentBoxInHtml": "<div>When facing a production issue, I follow a structured incident response process:\n1. Identify & Reproduce – I gather logs, error messages, and user reports to understand the issue. I try to reproduce it in a staging environment before making any changes.\n2. Analyze Root Cause – I use log monitoring tools (ELK, Splunk, Datadog) and debugging techniques to pinpoint the issue. If necessary, I perform database queries and check server metrics.\n3. Apply Fix & Test – I create a hotfix branch, implement a solution, and test it thoroughly in a non-production environment.\n4. Deploy & Monitor – After approval, I deploy the fix using zero-downtime deployment and closely monitor the application to ensure stability.\n5. Prevent Future Issues – I conduct a post-mortem analysis, document the resolution, and implement preventive measures like automated alerts, better exception handling, and code optimizations.\n</div>",
"score": "4"
}
}
]
},
{
"id": 127,
"questionName": "Team member section",
"score": "2.50"
},
{
"id": 128,
"questionName": "Full Name",
"responseValue": "John Doe"
},
{
"id": 129,
"questionName": "What were your key achievements this quarter?\t",
"responseValue": "Successfully led a new feature development, improved system performance by 20%, and mentored two new team members.",
"responseValueInHtml": "<div>Successfully led a new feature development, improved system performance by 20%, and mentored two new team members.</div>"
},
{
"id": 130,
"questionName": "Date of Joining\t",
"responseValue": "2024-02-26"
},
{
"id": 131,
"questionName": "Which skills have you improved the most?",
"response": {
"value": [
{
"id": 1,
"value": "Problem-solving"
}
],
"commentBox": "Over the past few months, I have significantly improved my problem-solving skills by working on complex technical challenges and optimizing existing workflows. I have learned to break down large problems into smaller, manageable tasks and systematically analyze different solutions.\nI have also started using debugging tools, design patterns, and data structures more effectively to write optimized and scalable code. Participating in code reviews and brainstorming sessions with my team has further refined my approach to tackling issues efficiently.\nAdditionally, I have taken part in coding challenges and real-world troubleshooting scenarios, which have enhanced my ability to think critically and resolve problems quickly in high-pressure situations.",
"commentBoxInHtml": "<div>Over the past few months, I have significantly improved my problem-solving skills by working on complex technical challenges and optimizing existing workflows. I have learned to break down large problems into smaller, manageable tasks and systematically analyze different solutions.\nI have also started using debugging tools, design patterns, and data structures more effectively to write optimized and scalable code. Participating in code reviews and brainstorming sessions with my team has further refined my approach to tackling issues efficiently.\nAdditionally, I have taken part in coding challenges and real-world troubleshooting scenarios, which have enhanced my ability to think critically and resolve problems quickly in high-pressure situations.</div>",
"score": "1"
}
},
{
"id": 132,
"questionName": "What additional skills would you like to develop?",
"response": {
"value": [
{
"id": 0,
"value": "Cloud Computing"
},
{
"id": 2,
"value": "ReactJs"
}
],
"commentBox": "Will work on this skils.",
"commentBoxInHtml": "<div>Will work on this skils.</div>"
}
},
{
"id": 133,
"questionName": "How would you rate your overall performance?",
"response": {
"value": [
{
"id": 4,
"value": "Exceeds expectations"
}
],
"commentBox": "I am happy with my performance.",
"commentBoxInHtml": "<div>I am happy with my performance.</div>",
"score": "4"
}
},
{
"id": 134,
"questionName": "How satisfied are you with your current role?",
"response": {
"value": [
{
"id": 2,
"value": "Satisfied"
}
],
"commentBox": "I am satisfied.",
"commentBoxInHtml": "<div>I am satisfied.</div>",
"score": "2"
}
},
{
"id": 135,
"questionName": "Do you need additional support from your manager?",
"response": {
"value": [
{
"id": 1,
"value": "Yes"
}
],
"commentBox": "In same cases.",
"commentBoxInHtml": "<div>In same cases.</div>"
}
},
{
"id": 136,
"questionName": "On a scale of 1-10, how would you rate your work-life balance?",
"response": {
"value": [
{
"id": 3,
"value": "3"
}
],
"commentBox": "I am happy with work-life balance.",
"commentBoxInHtml": "<div>I am happy with work-life balance.</div>",
"score": "3"
}
}
]
},
{
"tabName": "Reviewer",
"fields": [
{
"id": 125,
"questionName": "Objectives",
"score": "NA"
},
{
"id": 126,
"questionName": "Import Objectives",
"objectives": [
{
"objectiveId": 7,
"getObjectiveDetailsUrl": "<base_url>/rest/upraise/public/1.0/okr/objective/7",
"response": {
"value": [
{
"id": 3,
"value": "3"
}
],
"commentBox": "Agree with the team member assessment.",
"commentBoxInHtml": "<div>Agree with the team member assessment.</div>",
"score": "3"
}
},
{
"objectiveId": 12,
"getObjectiveDetailsUrl": "<base_url>/rest/upraise/public/1.0/okr/objective/12",
"response": {
"value": [
{
"id": 4,
"value": "4"
}
],
"commentBox": "Agree with the team member assessment.",
"commentBoxInHtml": "<div>Agree with the team member assessment.</div>",
"score": "4"
}
}
]
},
{
"id": 137,
"questionName": "Reviewer section",
"score": "4.00"
},
{
"id": 138,
"questionName": "Name",
"responseValue": "Smith"
},
{
"id": 139,
"questionName": "Team Member’s Strengths",
"responseValue": "Excellent problem-solving skills, proactive, and strong technical knowledge.",
"responseValueInHtml": "<div>Excellent problem-solving skills, proactive, and strong technical knowledge.</div>"
},
{
"id": 140,
"questionName": "What additional responsibilities can they take on?\t",
"responseValue": "Leading small projects and mentoring new hires.",
"responseValueInHtml": "<div>Leading small projects and mentoring new hires.</div>"
},
{
"id": 141,
"questionName": "How well does the team member collaborate with others?",
"response": {
"value": [
{
"id": 4,
"value": "Exceeds expectations"
}
],
"commentBox": "It is ok.",
"commentBoxInHtml": "<div>It is ok.</div>",
"score": "4"
}
}
]
},
{
"tabName": "HR Remarks",
"fields": [
{
"id": 143,
"questionName": "HR’s Final Remarks",
"responseValue": "The team member has shown great potential and growth. Recommend training sessions for leadership skills and a performance-based incentive.",
"responseValueInHtml": "<div>The team member has shown great potential and growth. Recommend training sessions for leadership skills and a performance-based incentive.</div>"
}
]
}
]
}API Response Parameters Table
Here’s your parameter table based on the JSON file, formatted similar to your reference table:
Parent | Parameter | Type | Description | Possible Values |
|---|---|---|---|---|
root | distributionId | Integer | Unique ID of the distribution | 3595 |
root | distributionName | String | Name/title of the form distribution | "H2 sales team review" |
root | getDistributionDetailsUrl | String | API URL to fetch distribution details | <baseURL>/rest/upraise/public/1.0/form/getDistributions?id=3595" |
root | startAt | Integer | Pagination Start | 0 |
root | maxResults | Integer | Maximum Results | 20 |
root | total | Integer | Total Count | 11 |
distributionUserDetails | isOpen | Boolean | Indicates if the distribution form is open | false |
teamMember / reviewer / assignedTo | id | Integer | User ID of respective role | Multiple values such as 6168, 6104, 6087, ... |
teamMember / reviewer / assignedTo | jiraUserRestApiUrl | String | Jira REST API URL to fetch user details | Corresponding URLs for each user |
status | id | Integer | Status ID | 1 |
status | name | String | Status label | Not Started, Reviewer in progress, team member in progress, etc.(may differ based on template workflow) |
responseDetails | responseType | String | Type of response | Manager, Peer, Direct Report, HR user, Reviewer, Team member (may differ based on template type) |
details | id | Integer | Detail ID | Multiple values such as 10263, 10262, ... |
details | getDistributionUserResponseUrl | String | API URL to fetch user response details | Corresponding URLs for each response |
On this page |
|---|
, multiple selections available,