Sample JSON response
| Code Block |
|---|
{
"startAt": 0,
"maxResults": 25,
"total": 2,
"results": [
{
"id": 1397,
"name": "QA Team",
"description": "This team is responsible for the QA of different apps.",
"descriptionInHtml": "<div><p>This team is responsible for the QA of different apps.</p></div>",
"teamLead": {
"id": 30843,
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=557058:c2609d00-1e17-4d01-99f4-9b4ba05d138c"
},
"parentTeam": {
"id": 1399,
"name": "UpRaise team"
},
"type": {
"id": 5919,
"name": "Software Teams"
},
"unit": {
"id": 307,
"name": "GR-01"
},
"teamMembersCount": 4,
"jiraGroupCount": 2
},
{
"id": 1399,
"name": "UpRaise team",
"unit": {
"id": 307,
"name": "GR-01"
},
"teamMembersCount": 2,
"jiraGroupCount": 0
}
]
} |
Response parameters
Parent | Parameter | Type | Description | Possible values |
|---|---|---|---|---|
startAt | Number | This will show the starting index for the search results. | 0, 1, 2, 3, etc. | |
maxResults | Number | This will show the max number of results on any given page. | Maximum allowed value of 50. If more than 50 value is sent in the request, the app will consider 50. | |
total | Number | This will indicate how many results in total exist for the given search. | Any number | |
results | Object (Array) | This object Object (Array) (Array) contains all the results of the teams retrived retrieved from this API | ||
id | Number | Team’s id ID in UpRaise | 1, 23, 45, etc. | |
name | String | Team’s name | Sales, Customer Success, etc. | |
description | String | Team’s description in UpRaise | Eg. At [Company Name], our Customer Success Team is dedicated to empowering our users to achieve their goals and maximize their value from our products. | |
descriptionInHtml | String | Team’s description in HTML | <div><p>At [Company Name], our Customer Success Team is dedicated to empowering our users to achieve their goals and maximize their value from our products.</p></div> | |
teamLead | Object (Array) | This object Object (Array) contains the details of user who is team lead of the current team. |
| |
teamLead | id | Number | User ID of the team lead | |
teamLead | jiraUserRestApiUrl | String | Jira user Rest API URL | <baseURL>/rest/api/2/user?accountId=557058:c2609d00-1e17-4d01-99f4-9b4ba05d138c |
parentTeam | Object (Array) | This object Object (Array) contains the details of user who is parent team of the current team. |
| |
parentTeam | id | Number | UpRaise team ID of parent team | 23. 25. etc. |
parentTeam | name | String | UpRaise name of parent team | Sales, HR, etc. |
type | String | Team type of the parent team |
| |
type | id | Number | ID of the team type | 12, 78, etc. |
type | name | String | Name of the team type | Operations, Department, Products, Technology, etc. |
unit | Object (Array) | This object Object (Array) contains the parameters of UpRaise unit |
| |
unit | id | Number | Unit id to IDto which the team belogs belongs to | 12, 78, etc. |
unit | name | String | Unit name to which the team belongs to | Asia, Business, etc. |
teamMembersCount | Number | Number of team memebers members in the team | 12, 70, etc. | |
jiraGroupCount | Number | Number of Jira groups associated with team | 4, 6, etc. |
Error handling
HTTP Status code | Error Message |
|---|---|
403 (FORBIDDEN) | The API token in the request is invalid. Please use a different one. You do not have permission to view teams. |