Function getAvatars

getAvatars(
    client: Client,
    parameters: {
        entityId: string;
        type: "priority" | string & {} | "project" | "issuetype";
    },
    options?: RequestOptions,
): Promise<
    {
        custom?: {
            fileName?: string;
            id: string;
            isDeletable?: boolean;
            isSelected?: boolean;
            isSystemAvatar?: boolean;
            owner?: string;
            urls?: Record<string, any>;
            [key: string]: unknown;
        }[];
        system?: {
            fileName?: string;
            id: string;
            isDeletable?: boolean;
            isSelected?: boolean;
            isSystemAvatar?: boolean;
            owner?: string;
            urls?: Record<string, any>;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
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
- client: Client
- parameters: { entityId: string; type: "priority" | string & {} | "project" | "issuetype" }
  - entityId: string
    
    The ID of the item the avatar is associated with.
  - type: "priority" | string & {} | "project" | "issuetype"
    
    The avatar type.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        custom?: {
            fileName?: string;
            id: string;
            isDeletable?: boolean;
            isSelected?: boolean;
            isSystemAvatar?: boolean;
            owner?: string;
            urls?: Record<string, any>;
            [key: string]: unknown;
        }[];
        system?: {
            fileName?: string;
            id: string;
            isDeletable?: boolean;
            isSelected?: boolean;
            isSystemAvatar?: boolean;
            owner?: string;
            urls?: Record<string, any>;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
- Defined in src/cloud/api/avatars.ts:50

Function getAvatars

Parameters

entityId: string

type: "priority" | string & {} | "project" | "issuetype"

Settings