getTeamDetails

Background

This REST API is meant to provide details of the given team in UpRaise company directory.

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

Request

Below are the endpoints for this API based on which UpRaise app you are using. The below endpoints are to get team details and to download team logo.

App name	Endpoint
UpRaise for Employee Success	https://employee-success.upraise.io/rest/upraise/public/1.0/directory/team/{teamId} https://employee-success.upraise.io/rest/upraise/public/1.0/directory/teamlogo/{teamId}
UpRaise People	https://people.upraise.io/rest/upraise/public/1.0/directory/team/{teamId} https://people.upraise.io/rest/upraise/public/1.0/directory/teamlogo/{teamId}
UpRaise Employee Garrison	https://garrison.upraise.io/rest/upraise/public/1.0/directory/team/{teamId} https://garrison.upraise.io/rest/rest/upraise/public/1.0/directory/teamlogo/{teamId}

On this page
Background API Details Request Sample JSON response Response parameters

Sample JSON response

{
    "id": 1359,
    "name": "QA Team",
    "description": "Qa Team is responsible for creating and running tests, identifying errors and providing feedback to ensure a final product meets a company's quality standards.",
    "descriptionInHtml": "<div><p>Qa Team is responsible for creating and running tests, identifying errors and providing feedback to ensure a final product meets a company's quality standards.</p></div>",
    "teamLead": {
        "id": 30837,
        "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
    },
    "parentTeam": {
        "id": 1412,
        "name": "Product Team",
        "description": "This team is responsible for product management."
    },
    "type": {
        "id": 5946,
        "name": "Business"
    },
    "jiraGroups": "test_group",
    "teamMembers": [
        {
            "upRaiseInfo": {
                "id": 30837,
                "ownerDesignation": {
                    "id": 785,
                    "name": "Data Analyst"
                }
            },
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
        },
        {
            "upRaiseInfo": {
                "id": 30712,
                "ownerDesignation": {
                    "id": 759,
                    "name": "Consultant, eLearning & Systems"
                }
            },
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=557058:abffcb82-281b-422b-ad3a-683362ccd4db"
        },
        {
            "upRaiseInfo": {
                "id": 30710,
                "ownerDesignation": {}
            },
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62"
        }
    ],
    "externalId": "1359",
    "unit": {
        "id": 310,
        "name": "Unit 1"
    },
    "teamLogoApiUrl": "<baseURL>/rest/upraise/public/1.0/directory/teamlogo/1359",
    "creator": {
        "id": 30710,
        "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62"
    },
    "created": "12/February/2024 13:29:52 PM",
    "modifiedBy": {
        "id": 30710,
        "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62"
    },
    "modified": "10/April/2024 14:16:08 PM",
    "dateTimeFormat": "dd/MMMM/yyyy HH:mm:ss aa",
    "dateFormat": "dd/MM/yy",
    "status": "Active"
}

Response parameters

Parent	Parameters	Type	Description	Possible values

Parent	Parameters	Type	Description	Possible values
	id	Number	UpRaise team id	1234, 12, etc.
	Name	String	UpRaise team name	Sales, Support, etc.
	description	String	UpRaise team description	This team is responsible for creating and running tests, identifying errors and providing feedback to ensure a final product meets a company's quality standards.
	descriptionInHtml	String	Team description in HTML	<div><p>This team is responsible for creating and running tests, identifying errors and providing feedback to ensure a final product meets a company's quality standards.</p></div>
	teamLead	String	This parameter contains the details of the user assigned as team lead	id jiraUserRestApiUrl
teamLead	id	Number	UpRaise user ID of the team lead	72, 89, etc.
teamLead	jiraUserRestApiUrl	String	Jira user API URL of the team lead	<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8
	parentTeam	String	This parameter contains the details of the parent team of the current team	id name description
parentTeam	id	Number	UpRaise team ID of the parent team	12, 828, etc.
parentTeam	name	String	Name of the parent team	Business, Operations
parentTeam	description	String	Description of the parent team	This team is responsible for product management.
	type	String	Team type as per UpRaise company directory setup	id name
type	id	Number	Team type id	12, 72, etc.
type	name	String	Team type name	Department, Technology
	jiraGroups	String	Jira groups synced with UpRaise team	Administrators, Jira admins, customers, partners, etc.
	teamMembers	String	This parameter contains the details of team members in the current team	upRaiseInfo ownerDesignation JiraUserRestApiUrl
teamMembers	upRaiseInfo	String	This parameter contains UpRaise user details like ID, UpRaise	id
upRaiseInfo	id	Number	UpRaise user ID of the team member	44, 45, etc.
upRaiseInfo	ownerDesignation	String	This parameter contains user’s UpRaise designation details	id name
ownerDesignation	id	Number
ownerDesignation	name	String
teamMembers	jiraUserRestApiUrl	String	UpRaise user’s Jira user Rest API URL	<baseURL>/rest/api/2/user?accountId=557058:abffcb82-281b-422b-ad3a-683362ccd4db
	externalId	String	User’s is from different tools when synced via HRMS	Any ID
	unit	String	UpRaise Unit that team belongs to	id name
unit	id	Number	UpRaise unit ID	12, 14, etc.
unit	name	String	UpRaise unit name	India, Products, etc.
	teamLogoApiUrl	String	URL for team’s logo	https://people-qa.upraise.io/rest/upraise/public/1.0/directory/teamlogo/1359
	creator	String	User’s details who created the team	id jiraUserRestApiUrl
creator	id	Number	ID of the user who created the team	23, 44, etc.
creator	jiraUserRestApiUrl	String	Jira user API URL of the user who created UpRaise team	<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62
	created	String	Date and time when team was created	12/February/2024 13:29:52 PM
	modifiedBy	String	User details who modified team	id jiraUserApiUrl
modifiedBy	id	Number	ID of the user who modified the team	14, 44, etc.
modifiedBy	jiraUserApiUrl	String	Jira user API URL of the user who modified UpRaise team	<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62
	modified	String	Date when user last modified team	10/April/2024 14:16:08 PM
	dateTimeFormat	String	Format definition of date fields returned in response.	dd/MMMM/yyyy HH:mm:ss aa
	dateFormat	String	Format definition of date fields returned in response.	dd/MM/yy
	status	String	Status of team	Active Inactive