Function: getProject()

function getProject(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  archived?: boolean;
  avatarUrls?: Record<string, string>;
  description?: string;
  id?: string;
  key?: string;
  name?: string;
  self?: string;
}>;

Defined in: src/server/api/projects.ts:176

Returns a full representation of a project in JSON format. All project keys associated with the project will only be returned if expand=projectKeys.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ expand?: string; projectIdOrKey: string; }	-
parameters.expand?	string	Parameters to expand
parameters.projectIdOrKey?	string	Project id or project key
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; archived?: boolean; avatarUrls?: Record<string, string>; description?: string; id?: string; key?: string; name?: string; self?: string; }>