Function: getTeam()

function getTeam(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  creatorId?: string | null;
  description: string;
  displayName: string;
  externalReference?:   | {
   [key: string]: unknown;
     id: string;
     source: string & object | "ATLASSIAN_GROUP" | "HRIS";
   }
     | null;
  organizationId: string;
  state: string & object | "ACTIVE" | "ARCHIVED";
  teamId: string;
  teamType:   | string & object
     | "EXTERNAL"
     | "OPEN"
     | "MEMBER_INVITE"
     | "ORG_ADMIN_MANAGED";
  userPermissions: {
   [key: string]: unknown;
     ADD_MEMBERS: boolean;
     DELETE_TEAM: boolean;
     REMOVE_MEMBERS: boolean;
     UPDATE_TEAM: boolean;
  };
}>;

Defined in: src/teams/api/teams.ts:98

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ orgId: string; siteId?: string; teamId: string; }	-
parameters.orgId	string	The ID of the organisation the team is to be retrieved from.
parameters.siteId?	string	[Optional] The ID of the site to retrieve teams which are site scoped. Please note that if the org is site-scoped, teams will not be included in response if siteId is not provided. [Deprecated] Omitting siteId is deprecated. With the introduction of Units, orgId alone is no longer sufficient to resolve the scope of teams. Always provide a valid siteId to ensure this operation continues to work in the future.
parameters.teamId?	string	The ID of the team to be retrieved.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; creatorId?: string | null; description: string; displayName: string; externalReference?: | { [key: string]: unknown; id: string; source: string & object | "ATLASSIAN_GROUP" | "HRIS"; } | null; organizationId: string; state: string & object | "ACTIVE" | "ARCHIVED"; teamId: string; teamType: | string & object | "EXTERNAL" | "OPEN" | "MEMBER_INVITE" | "ORG_ADMIN_MANAGED"; userPermissions: { [key: string]: unknown; ADD_MEMBERS: boolean; DELETE_TEAM: boolean; REMOVE_MEMBERS: boolean; UPDATE_TEAM: boolean; }; }>