Avatars

Provides user avatars. User avatars are provided by the https://avataaars.com/ library.

Rationale

All users have an avatar associated with them. A default avatar will be returned if one is not found in the database. As a result, this service does not need to listen for user created events.

The avatar are mainly used as a way for users to easier distinguish between different users when sharing or working in projects.

---

⚠️ WARNING: The API listed on this page will likely change to conform with our API conventions. Be careful when building integrations. The following changes are expected:

• RPC names will change to conform with the conventions

• RPC request and response types will change to conform with the conventions

• RPCs which return a page will be collapsed into a single browse endpoint

• Some property names will change to be consistent with Resources

---

Table of Contents

1. Remote Procedure Calls

Name	Description
findAvatar	Request the avatar of the current user.
findBulk	Request the avatars of one or more users by username.
update	Update the avatar of the current user.

2. Data Models

Name	Description
Avatar	No description
Clothes	No description
ClothesGraphic	No description
ColorFabric	No description
Eyebrows	No description
Eyes	No description
FacialHair	No description
FacialHairColor	No description
HairColor	No description
HatColor	No description
MouthTypes	No description
SkinColors	No description
Top	No description
TopAccessory	No description
FindBulkRequest	No description
FindBulkResponse	No description

Remote Procedure Calls

findAvatar

Request the avatar of the current user.

Request	Response	Error
Unit	Avatar	CommonErrorMessage

findBulk

Request the avatars of one or more users by username.

Request	Response	Error
FindBulkRequest	FindBulkResponse	CommonErrorMessage

update

Update the avatar of the current user.

Request	Response	Error
Avatar	Unit	CommonErrorMessage

Data Models

Avatar

data class Avatar(
    val top: Top,
    val topAccessory: TopAccessory,
    val hairColor: HairColor,
    val facialHair: FacialHair,
    val facialHairColor: FacialHairColor,
    val clothes: Clothes,
    val colorFabric: ColorFabric,
    val eyes: Eyes,
    val eyebrows: Eyebrows,
    val mouthTypes: MouthTypes,
    val skinColors: SkinColors,
    val clothesGraphic: ClothesGraphic,
    val hatColor: HatColor,
)

Properties

top: Top

topAccessory: TopAccessory

hairColor: HairColor

facialHair: FacialHair

facialHairColor: FacialHairColor

clothes: Clothes

colorFabric: ColorFabric

eyes: Eyes

eyebrows: Eyebrows

mouthTypes: MouthTypes

skinColors: SkinColors

clothesGraphic: ClothesGraphic

hatColor: HatColor

---

Clothes

enum class Clothes {
    BLAZER_SHIRT,
    BLAZER_SWEATER,
    COLLAR_SWEATER,
    GRAPHIC_SHIRT,
    HOODIE,
    OVERALL,
    SHIRT_CREW_NECK,
    SHIRT_SCOOP_NECK,
    SHIRT_V_NECK,
}

Properties

BLAZER_SHIRT

BLAZER_SWEATER

COLLAR_SWEATER

GRAPHIC_SHIRT

HOODIE

OVERALL

SHIRT_CREW_NECK

SHIRT_SCOOP_NECK

SHIRT_V_NECK

---

ClothesGraphic

enum class ClothesGraphic {
    BAT,
    CUMBIA,
    DEER,
    DIAMOND,
    HOLA,
    PIZZA,
    RESIST,
    SELENA,
    BEAR,
    SKULL_OUTLINE,
    SKULL,
    ESPIE,
    ESCIENCELOGO,
    TEETH,
}

Properties

BAT

CUMBIA

DEER

DIAMOND

HOLA

PIZZA

RESIST

SELENA

BEAR

SKULL_OUTLINE

SKULL

ESPIE

ESCIENCELOGO

TEETH

---

ColorFabric

enum class ColorFabric {
    BLACK,
    BLUE01,
    BLUE02,
    BLUE03,
    GRAY01,
    GRAY02,
    HEATHER,
    PASTEL_BLUE,
    PASTEL_GREEN,
    PASTEL_ORANGE,
    PASTEL_RED,
    PASTEL_YELLOW,
    PINK,
    RED,
    WHITE,
}

Properties

BLACK

BLUE01

BLUE02

BLUE03

GRAY01

GRAY02

HEATHER

PASTEL_BLUE

PASTEL_GREEN

PASTEL_ORANGE

PASTEL_RED

PASTEL_YELLOW

PINK

RED

WHITE

---

Eyebrows

enum class Eyebrows {
    ANGRY,
    ANGRY_NATURAL,
    DEFAULT,
    DEFAULT_NATURAL,
    FLAT_NATURAL,
    FROWN_NATURAL,
    RAISED_EXCITED,
    RAISED_EXCITED_NATURAL,
    SAD_CONCERNED,
    SAD_CONCERNED_NATURAL,
    UNIBROW_NATURAL,
    UP_DOWN,
    UP_DOWN_NATURAL,
}

Properties

ANGRY

ANGRY_NATURAL

DEFAULT

DEFAULT_NATURAL

FLAT_NATURAL

FROWN_NATURAL

RAISED_EXCITED

RAISED_EXCITED_NATURAL

SAD_CONCERNED

SAD_CONCERNED_NATURAL

UNIBROW_NATURAL

UP_DOWN

UP_DOWN_NATURAL

---

Eyes

enum class Eyes {
    CLOSE,
    CRY,
    DEFAULT,
    DIZZY,
    EYE_ROLL,
    HAPPY,
    HEARTS,
    SIDE,
    SQUINT,
    SURPRISED,
    WINK,
    WINK_WACKY,
}

Properties

CLOSE

CRY

DEFAULT

DIZZY

EYE_ROLL

HAPPY

HEARTS

SIDE

SQUINT

SURPRISED

WINK

WINK_WACKY

---

FacialHair

enum class FacialHair {
    BLANK,
    BEARD_MEDIUM,
    BEARD_LIGHT,
    BEARD_MAJESTIC,
    MOUSTACHE_FANCY,
    MOUSTACHE_MAGNUM,
}

Properties

BLANK

BEARD_MEDIUM

BEARD_LIGHT

BEARD_MAJESTIC

MOUSTACHE_FANCY

MOUSTACHE_MAGNUM

---

FacialHairColor

enum class FacialHairColor {
    AUBURN,
    BLACK,
    BLONDE,
    BLONDE_GOLDEN,
    BROWN,
    BROWN_DARK,
    PLATINUM,
    RED,
}

Properties

AUBURN

BLACK

BLONDE

BLONDE_GOLDEN

BROWN

BROWN_DARK

PLATINUM

RED

---

HairColor

enum class HairColor {
    AUBURN,
    BLACK,
    BLONDE,
    BLONDE_GOLDEN,
    BROWN,
    BROWN_DARK,
    PASTEL_PINK,
    PLATINUM,
    RED,
    SILVER_GRAY,
}

Properties

AUBURN

BLACK

BLONDE

BLONDE_GOLDEN

BROWN

BROWN_DARK

PASTEL_PINK

PLATINUM

RED

SILVER_GRAY

---

HatColor

enum class HatColor {
    BLACK,
    BLUE01,
    BLUE02,
    BLUE03,
    GRAY01,
    GRAY02,
    HEATHER,
    PASTELBLUE,
    PASTELGREEN,
    PASTELORANGE,
    PASTELRED,
    PASTELYELLOW,
    PINK,
    RED,
    WHITE,
}

Properties

BLACK

BLUE01

BLUE02

BLUE03

GRAY01

GRAY02

HEATHER

PASTELBLUE

PASTELGREEN

PASTELORANGE

PASTELRED

PASTELYELLOW

PINK

RED

WHITE

---

MouthTypes

enum class MouthTypes {
    CONCERNED,
    DEFAULT,
    DISBELIEF,
    EATING,
    GRIMACE,
    SAD,
    SCREAM_OPEN,
    SERIOUS,
    SMILE,
    TONGUE,
    TWINKLE,
    VOMIT,
}

Properties

CONCERNED

DEFAULT

DISBELIEF

EATING

GRIMACE

SAD

SCREAM_OPEN

SERIOUS

SMILE

TONGUE

TWINKLE

VOMIT

---

SkinColors

enum class SkinColors {
    TANNED,
    YELLOW,
    PALE,
    LIGHT,
    BROWN,
    DARK_BROWN,
    BLACK,
}

Properties

TANNED

YELLOW

PALE

LIGHT

BROWN

DARK_BROWN

BLACK

---

Top

enum class Top {
    NO_HAIR,
    EYEPATCH,
    HAT,
    HIJAB,
    TURBAN,
    WINTER_HAT1,
    WINTER_HAT2,
    WINTER_HAT3,
    WINTER_HAT4,
    LONG_HAIR_BIG_HAIR,
    LONG_HAIR_BOB,
    LONG_HAIR_BUN,
    LONG_HAIR_CURLY,
    LONG_HAIR_CURVY,
    LONG_HAIR_DREADS,
    LONG_HAIR_FRIDA,
    LONG_HAIR_FRO,
    LONG_HAIR_FRO_BAND,
    LONG_HAIR_NOT_TOO_LONG,
    LONG_HAIR_SHAVED_SIDES,
    LONG_HAIR_MIA_WALLACE,
    LONG_HAIR_STRAIGHT,
    LONG_HAIR_STRAIGHT2,
    LONG_HAIR_STRAIGHT_STRAND,
    SHORT_HAIR_DREADS01,
    SHORT_HAIR_DREADS02,
    SHORT_HAIR_FRIZZLE,
    SHORT_HAIR_SHAGGY_MULLET,
    SHORT_HAIR_SHORT_CURLY,
    SHORT_HAIR_SHORT_FLAT,
    SHORT_HAIR_SHORT_ROUND,
    SHORT_HAIR_SHORT_WAVED,
    SHORT_HAIR_SIDES,
    SHORT_HAIR_THE_CAESAR,
    SHORT_HAIR_THE_CAESAR_SIDE_PART,
}

Properties

NO_HAIR

EYEPATCH

HAT

HIJAB

TURBAN

WINTER_HAT1

WINTER_HAT2

WINTER_HAT3

WINTER_HAT4

LONG_HAIR_BIG_HAIR

LONG_HAIR_BOB

LONG_HAIR_BUN

LONG_HAIR_CURLY

LONG_HAIR_CURVY

LONG_HAIR_DREADS

LONG_HAIR_FRIDA

LONG_HAIR_FRO

LONG_HAIR_FRO_BAND

LONG_HAIR_NOT_TOO_LONG

LONG_HAIR_SHAVED_SIDES

LONG_HAIR_MIA_WALLACE

LONG_HAIR_STRAIGHT

LONG_HAIR_STRAIGHT2

LONG_HAIR_STRAIGHT_STRAND

SHORT_HAIR_DREADS01

SHORT_HAIR_DREADS02

SHORT_HAIR_FRIZZLE

SHORT_HAIR_SHAGGY_MULLET

SHORT_HAIR_SHORT_CURLY

SHORT_HAIR_SHORT_FLAT

SHORT_HAIR_SHORT_ROUND

SHORT_HAIR_SHORT_WAVED

SHORT_HAIR_SIDES

SHORT_HAIR_THE_CAESAR

SHORT_HAIR_THE_CAESAR_SIDE_PART

---

TopAccessory

enum class TopAccessory {
    BLANK,
    KURT,
    PRESCRIPTION01,
    PRESCRIPTION02,
    ROUND,
    SUNGLASSES,
    WAYFARERS,
}

Properties

BLANK

KURT

PRESCRIPTION01

PRESCRIPTION02

ROUND

SUNGLASSES

WAYFARERS

---

FindBulkRequest

data class FindBulkRequest(
    val usernames: List<String>,
)

Properties

usernames: List<String>

---

FindBulkResponse

data class FindBulkResponse(
    val avatars: JsonObject,
)

Properties

avatars: JsonObject

---