Function: getAvatarUrl()

getAvatarUrl(client, props): URL

Gets the URL for an avatar.

Parameters

client

ApiClient

The API client instance

props

The request properties

query

{ width?: number; height?: number; quality?: number; format?: "webp" | "avif" | "jpg" | "png"; redirectOnNotFound?: string; cacheKey?: string; orgName: string; projectName: string; } | { width?: number; height?: number; quality?: number; format?: "webp" | "avif" | "jpg" | "png"; redirectOnNotFound?: string; cacheKey?: string; orgName: string; } = getAvatarQuerySchema

Query parameters (orgName, optional projectName, image transform options)

Returns

URL

URL object for the avatar

Operation Id

get-avatar

Example

const avatarUrl = getAvatarUrl(client, {
  query: { orgName: 'my-org', width: 200, height: 200 }
});