Skip to content

BadgeChoice

A role that the authenticated user holds and that has a badge, with whether the user shows the badge on their profile. A badge is hidden until the user shows it; losing the role or its badge hides it again.

object
role_id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
label
required

The name on the badge.

string
color
required

The color of a role badge: the name of a pair of the web client’s design tokens for its background and its text, which keep their contrast in the light and the dark theme. Server themes do not change them. The color is decoration; the badge’s label carries its meaning.

string
Allowed values: neutral red orange yellow green teal blue purple pink
displayed
required

Whether the user shows the badge on their profile.

boolean

Example generated

{
"role_id": "01890a5d-ac96-774b-bcce-b302099a8057",
"label": "example",
"color": "neutral",
"displayed": true
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site