Skip to content

Function: getAvatars() ​

ts
function getAvatars(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  custom?: object[];
  system?: object[];
}>;

Defined in: src/cloud/api/avatars.ts:50

Returns the system and custom avatars for a project, issue type or priority.

This operation can be accessed anonymously.

Permissions required:

  • For custom project avatars, Browse projects project permission for the project the avatar belongs to.
  • For custom issue type avatars, Browse projects project permission for at least one project the issue type is used in.
  • For system avatars, none.
  • For priority avatars, none.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ entityId: string; type: "priority" | string & object | "project" | "issuetype"; }-
parameters.entityIdstringThe ID of the item the avatar is associated with.
parameters.type?"priority" | string & object | "project" | "issuetype"The avatar type.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; custom?: object[]; system?: object[]; }>