Classic APIs
ClassicThumbnailsApi
avatarsHeadshotsThumbnails

avatarsHeadshotsThumbnails

Gets avatar headshot thumbnail for multiple users.

Parameters

NameTypeDescription
userIdsArrayNonEmptyIfConstThe ids of the users to get thumbnails for.
size?AvatarsFullThumbnailsSizeThe avatar thumbnails size (formatted as {width}x{height}).
format?ThumbnailFormatSpecifies the format of the thumbnails.
isCircular?booleanDictates if the thumbnails should be masked by a circle.

Example

const { data: avatarsHeadshotsThumbnails } = await ClassicThumbnailsApi.avatarsHeadshotsThumbnails({
  userIds: [45348281],
  size: "720x720",
}); 

Example Data

{
  "45348281": {
    state: "Completed",
    imageUrl: "https://t0.rbxcdn.com/697567606503f6484a06e8617307d54f",
  },
} 

Endpoint

GET /v1/users/avatar-headshot